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 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/>.
23 #include "system/syslog.h"
24 #include "system/filesys.h"
26 #include "../librpc/gen_ndr/ndr_spoolss.h"
27 #include "nt_printing.h"
28 #include "../librpc/gen_ndr/netlogon.h"
29 #include "printing/notify.h"
30 #include "printing/pcap.h"
31 #include "printing/printer_list.h"
32 #include "printing/queue_process.h"
34 #include "smbd/smbd.h"
38 #include "lib/param/loadparm.h"
39 #include "lib/util/sys_rw_data.h"
41 extern userdom_struct current_user_info;
43 /* Current printer interface */
44 static bool remove_from_jobs_added(const char* sharename, uint32_t jobid);
47 the printing backend revolves around a tdb database that stores the
48 SMB view of the print queue
50 The key for this database is a jobid - a internally generated number that
51 uniquely identifies a print job
53 reading the print queue involves two steps:
54 - possibly running lpq and updating the internal database from that
55 - reading entries from the database
57 jobids are assigned when a job starts spooling.
60 static TDB_CONTEXT *rap_tdb;
61 static uint16_t next_rap_jobid;
62 struct rap_jobid_key {
67 /***************************************************************************
68 Nightmare. LANMAN jobid's are 16 bit numbers..... We must map them to 32
69 bit RPC jobids.... JRA.
70 ***************************************************************************/
72 uint16_t pjobid_to_rap(const char* sharename, uint32_t jobid)
76 struct rap_jobid_key jinfo;
79 DEBUG(10,("pjobid_to_rap: called.\n"));
82 /* Create the in-memory tdb. */
83 rap_tdb = tdb_open_log(NULL, 0, TDB_INTERNAL, (O_RDWR|O_CREAT), 0644);
89 fstrcpy( jinfo.sharename, sharename );
91 key.dptr = (uint8_t *)&jinfo;
92 key.dsize = sizeof(jinfo);
94 data = tdb_fetch(rap_tdb, key);
95 if (data.dptr && data.dsize == sizeof(uint16_t)) {
96 rap_jobid = SVAL(data.dptr, 0);
98 DEBUG(10,("pjobid_to_rap: jobid %u maps to RAP jobid %u\n",
99 (unsigned int)jobid, (unsigned int)rap_jobid));
102 SAFE_FREE(data.dptr);
103 /* Not found - create and store mapping. */
104 rap_jobid = ++next_rap_jobid;
106 rap_jobid = ++next_rap_jobid;
107 SSVAL(buf,0,rap_jobid);
109 data.dsize = sizeof(rap_jobid);
110 tdb_store(rap_tdb, key, data, TDB_REPLACE);
111 tdb_store(rap_tdb, data, key, TDB_REPLACE);
113 DEBUG(10,("pjobid_to_rap: created jobid %u maps to RAP jobid %u\n",
114 (unsigned int)jobid, (unsigned int)rap_jobid));
118 bool rap_to_pjobid(uint16_t rap_jobid, fstring sharename, uint32_t *pjobid)
123 DEBUG(10,("rap_to_pjobid called.\n"));
128 SSVAL(buf,0,rap_jobid);
130 key.dsize = sizeof(rap_jobid);
131 data = tdb_fetch(rap_tdb, key);
132 if ( data.dptr && data.dsize == sizeof(struct rap_jobid_key) )
134 struct rap_jobid_key *jinfo = (struct rap_jobid_key*)data.dptr;
135 if (sharename != NULL) {
136 fstrcpy( sharename, jinfo->sharename );
138 *pjobid = jinfo->jobid;
139 DEBUG(10,("rap_to_pjobid: jobid %u maps to RAP jobid %u\n",
140 (unsigned int)*pjobid, (unsigned int)rap_jobid));
141 SAFE_FREE(data.dptr);
145 DEBUG(10,("rap_to_pjobid: Failed to lookup RAP jobid %u\n",
146 (unsigned int)rap_jobid));
147 SAFE_FREE(data.dptr);
151 void rap_jobid_delete(const char* sharename, uint32_t jobid)
155 struct rap_jobid_key jinfo;
158 DEBUG(10,("rap_jobid_delete: called.\n"));
163 ZERO_STRUCT( jinfo );
164 fstrcpy( jinfo.sharename, sharename );
166 key.dptr = (uint8_t *)&jinfo;
167 key.dsize = sizeof(jinfo);
169 data = tdb_fetch(rap_tdb, key);
170 if (!data.dptr || (data.dsize != sizeof(uint16_t))) {
171 DEBUG(10,("rap_jobid_delete: cannot find jobid %u\n",
172 (unsigned int)jobid ));
173 SAFE_FREE(data.dptr);
177 DEBUG(10,("rap_jobid_delete: deleting jobid %u\n",
178 (unsigned int)jobid ));
180 rap_jobid = SVAL(data.dptr, 0);
181 SAFE_FREE(data.dptr);
182 SSVAL(buf,0,rap_jobid);
184 data.dsize = sizeof(rap_jobid);
185 tdb_delete(rap_tdb, key);
186 tdb_delete(rap_tdb, data);
189 static int get_queue_status(const char* sharename, print_status_struct *);
191 /****************************************************************************
192 Initialise the printing backend. Called once at startup before the fork().
193 ****************************************************************************/
195 bool print_backend_init(struct messaging_context *msg_ctx)
197 const char *sversion = "INFO/version";
198 int services = lp_numservices();
201 char *print_cache_path;
203 if (!printer_list_parent_init()) {
207 print_cache_path = cache_path(talloc_tos(), "printing");
208 if (print_cache_path == NULL) {
211 ok = directory_create_or_exist(print_cache_path, 0755);
212 TALLOC_FREE(print_cache_path);
217 print_cache_path = cache_path(talloc_tos(), "printing.tdb");
218 if (print_cache_path == NULL) {
221 unlink(print_cache_path);
222 TALLOC_FREE(print_cache_path);
224 /* handle a Samba upgrade */
226 for (snum = 0; snum < services; snum++) {
227 struct tdb_print_db *pdb;
228 if (!lp_printable(snum))
231 pdb = get_print_db_byname(lp_const_servicename(snum));
234 if (tdb_lock_bystring(pdb->tdb, sversion) != 0) {
235 DEBUG(0,("print_backend_init: Failed to open printer %s database\n", lp_const_servicename(snum) ));
236 release_print_db(pdb);
239 if (tdb_fetch_int32(pdb->tdb, sversion) != PRINT_DATABASE_VERSION) {
240 tdb_wipe_all(pdb->tdb);
241 tdb_store_int32(pdb->tdb, sversion, PRINT_DATABASE_VERSION);
243 tdb_unlock_bystring(pdb->tdb, sversion);
244 release_print_db(pdb);
247 close_all_print_db(); /* Don't leave any open. */
249 /* do NT print initialization... */
250 return nt_printing_init(msg_ctx);
253 /****************************************************************************
254 Shut down printing backend. Called once at shutdown to close the tdb.
255 ****************************************************************************/
257 void printing_end(void)
259 close_all_print_db(); /* Don't leave any open. */
262 /****************************************************************************
263 Retrieve the set of printing functions for a given service. This allows
264 us to set the printer function table based on the value of the 'printing'
267 Use the generic interface as the default and only use cups interface only
268 when asked for (and only when supported)
269 ****************************************************************************/
271 static struct printif *get_printer_fns_from_type( enum printing_types type )
273 struct printif *printer_fns = &generic_printif;
276 if ( type == PRINT_CUPS ) {
277 printer_fns = &cups_printif;
279 #endif /* HAVE_CUPS */
282 if ( type == PRINT_IPRINT ) {
283 printer_fns = &iprint_printif;
285 #endif /* HAVE_IPRINT */
287 printer_fns->type = type;
292 static struct printif *get_printer_fns( int snum )
294 return get_printer_fns_from_type( (enum printing_types)lp_printing(snum) );
298 /****************************************************************************
299 Useful function to generate a tdb key.
300 ****************************************************************************/
302 static TDB_DATA print_key(uint32_t jobid, uint32_t *tmp)
306 SIVAL(tmp, 0, jobid);
307 ret.dptr = (uint8_t *)tmp;
308 ret.dsize = sizeof(*tmp);
312 /****************************************************************************
313 Pack the devicemode to store it in a tdb.
314 ****************************************************************************/
315 static int pack_devicemode(struct spoolss_DeviceMode *devmode, uint8_t *buf, int buflen)
317 enum ndr_err_code ndr_err;
322 ndr_err = ndr_push_struct_blob(&blob, talloc_tos(),
324 (ndr_push_flags_fn_t)
325 ndr_push_spoolss_DeviceMode);
326 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
327 DEBUG(10, ("pack_devicemode: "
328 "error encoding spoolss_DeviceMode\n"));
335 len = tdb_pack(buf, buflen, "B", blob.length, blob.data);
338 DEBUG(8, ("Packed devicemode [%s]\n", devmode->formname));
345 /****************************************************************************
346 Unpack the devicemode to store it in a tdb.
347 ****************************************************************************/
348 static int unpack_devicemode(TALLOC_CTX *mem_ctx,
349 const uint8_t *buf, int buflen,
350 struct spoolss_DeviceMode **devmode)
352 struct spoolss_DeviceMode *dm;
353 enum ndr_err_code ndr_err;
355 uint32_t data_len = 0;
361 len = tdb_unpack(buf, buflen, "B", &data_len, &data);
366 dm = talloc_zero(mem_ctx, struct spoolss_DeviceMode);
371 blob = data_blob_const(data, data_len);
373 ndr_err = ndr_pull_struct_blob(&blob, dm, dm,
374 (ndr_pull_flags_fn_t)ndr_pull_spoolss_DeviceMode);
375 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
376 DEBUG(10, ("unpack_devicemode: "
377 "error parsing spoolss_DeviceMode\n"));
381 DEBUG(8, ("Unpacked devicemode [%s](%s)\n",
382 dm->devicename, dm->formname));
383 if (dm->driverextra_data.data) {
384 DEBUG(8, ("with a private section of %d bytes\n",
385 dm->__driverextra_length));
395 /***********************************************************************
396 unpack a pjob from a tdb buffer
397 ***********************************************************************/
399 static int unpack_pjob(TALLOC_CTX *mem_ctx, uint8_t *buf, int buflen,
400 struct printjob *pjob)
404 uint32_t pjpid, pjjobid, pjsysjob, pjfd, pjstarttime, pjstatus;
405 uint32_t pjsize, pjpage_count, pjspooled, pjsmbjob;
411 len += tdb_unpack(buf+len, buflen-len, "ddddddddddfffff",
432 used = unpack_devicemode(mem_ctx, buf+len, buflen-len, &pjob->devmode);
440 pjob->jobid = pjjobid;
441 pjob->sysjob = pjsysjob;
443 pjob->starttime = pjstarttime;
444 pjob->status = pjstatus;
446 pjob->page_count = pjpage_count;
447 pjob->spooled = pjspooled;
448 pjob->smbjob = pjsmbjob;
454 /****************************************************************************
455 Useful function to find a print job in the database.
456 ****************************************************************************/
458 static struct printjob *print_job_find(TALLOC_CTX *mem_ctx,
459 const char *sharename,
462 struct printjob *pjob;
465 struct tdb_print_db *pdb = get_print_db_byname(sharename);
467 DEBUG(10,("print_job_find: looking up job %u for share %s\n",
468 (unsigned int)jobid, sharename ));
474 ret = tdb_fetch(pdb->tdb, print_key(jobid, &tmp));
475 release_print_db(pdb);
478 DEBUG(10, ("print_job_find: failed to find jobid %u.\n",
483 pjob = talloc_zero(mem_ctx, struct printjob);
488 if (unpack_pjob(mem_ctx, ret.dptr, ret.dsize, pjob) == -1) {
489 DEBUG(10, ("failed to unpack jobid %u.\n", jobid));
495 DEBUG(10,("print_job_find: returning system job %d for jobid %u.\n",
496 pjob->sysjob, jobid));
497 SMB_ASSERT(pjob->jobid == jobid);
504 struct job_traverse_state {
509 /* find spoolss jobid based on sysjob */
510 static int sysjob_to_jobid_traverse_fn(TDB_CONTEXT *the_tdb, TDB_DATA key,
511 TDB_DATA data, void *private_data)
513 struct printjob *pjob;
514 struct job_traverse_state *state =
515 (struct job_traverse_state *)private_data;
517 if (!data.dptr || data.dsize == 0)
520 pjob = (struct printjob *)data.dptr;
521 if (key.dsize != sizeof(uint32_t))
524 if (state->sysjob == pjob->sysjob) {
525 state->jobid = pjob->jobid;
532 uint32_t sysjob_to_jobid_pdb(struct tdb_print_db *pdb, int sysjob)
534 struct job_traverse_state state;
536 state.sysjob = sysjob;
537 state.jobid = (uint32_t)-1;
539 tdb_traverse(pdb->tdb, sysjob_to_jobid_traverse_fn, &state);
544 /****************************************************************************
545 This is a *horribly expensive call as we have to iterate through all the
546 current printer tdb's. Don't do this often ! JRA.
547 ****************************************************************************/
549 uint32_t sysjob_to_jobid(int unix_jobid)
551 int services = lp_numservices();
553 struct job_traverse_state state;
555 state.sysjob = unix_jobid;
556 state.jobid = (uint32_t)-1;
558 for (snum = 0; snum < services; snum++) {
559 struct tdb_print_db *pdb;
560 if (!lp_printable(snum))
562 pdb = get_print_db_byname(lp_const_servicename(snum));
566 tdb_traverse(pdb->tdb, sysjob_to_jobid_traverse_fn, &state);
567 release_print_db(pdb);
568 if (state.jobid != (uint32_t)-1)
574 /* find sysjob based on spoolss jobid */
575 static int jobid_to_sysjob_traverse_fn(TDB_CONTEXT *the_tdb, TDB_DATA key,
576 TDB_DATA data, void *private_data)
578 struct printjob *pjob;
579 struct job_traverse_state *state =
580 (struct job_traverse_state *)private_data;
582 if (!data.dptr || data.dsize == 0)
585 pjob = (struct printjob *)data.dptr;
586 if (key.dsize != sizeof(uint32_t))
589 if (state->jobid == pjob->jobid) {
590 state->sysjob = pjob->sysjob;
597 int jobid_to_sysjob_pdb(struct tdb_print_db *pdb, uint32_t jobid)
599 struct job_traverse_state state;
604 tdb_traverse(pdb->tdb, jobid_to_sysjob_traverse_fn, &state);
609 /****************************************************************************
610 Send notifications based on what has changed after a pjob_store.
611 ****************************************************************************/
613 static const struct {
615 uint32_t spoolss_status;
616 } lpq_to_spoolss_status_map[] = {
617 { LPQ_QUEUED, JOB_STATUS_QUEUED },
618 { LPQ_PAUSED, JOB_STATUS_PAUSED },
619 { LPQ_SPOOLING, JOB_STATUS_SPOOLING },
620 { LPQ_PRINTING, JOB_STATUS_PRINTING },
621 { LPQ_DELETING, JOB_STATUS_DELETING },
622 { LPQ_OFFLINE, JOB_STATUS_OFFLINE },
623 { LPQ_PAPEROUT, JOB_STATUS_PAPEROUT },
624 { LPQ_PRINTED, JOB_STATUS_PRINTED },
625 { LPQ_DELETED, JOB_STATUS_DELETED },
626 { LPQ_BLOCKED, JOB_STATUS_BLOCKED_DEVQ },
627 { LPQ_USER_INTERVENTION, JOB_STATUS_USER_INTERVENTION },
631 /* Convert a lpq status value stored in printing.tdb into the
632 appropriate win32 API constant. */
634 static uint32_t map_to_spoolss_status(uint32_t lpq_status)
638 while (lpq_to_spoolss_status_map[i].lpq_status != -1) {
639 if (lpq_to_spoolss_status_map[i].lpq_status == lpq_status)
640 return lpq_to_spoolss_status_map[i].spoolss_status;
647 /***************************************************************************
648 Append a jobid to the 'jobs changed' list.
649 ***************************************************************************/
651 static bool add_to_jobs_changed(struct tdb_print_db *pdb, uint32_t jobid)
654 uint32_t store_jobid;
656 SIVAL(&store_jobid, 0, jobid);
657 data.dptr = (uint8_t *) &store_jobid;
660 DEBUG(10,("add_to_jobs_added: Added jobid %u\n", (unsigned int)jobid ));
662 return (tdb_append(pdb->tdb, string_tdb_data("INFO/jobs_changed"),
666 /***************************************************************************
667 Remove a jobid from the 'jobs changed' list.
668 ***************************************************************************/
670 static bool remove_from_jobs_changed(const char* sharename, uint32_t jobid)
672 struct tdb_print_db *pdb = get_print_db_byname(sharename);
676 bool gotlock = False;
684 key = string_tdb_data("INFO/jobs_changed");
686 if (tdb_chainlock_with_timeout(pdb->tdb, key, 5) != 0)
691 data = tdb_fetch(pdb->tdb, key);
693 if (data.dptr == NULL || data.dsize == 0 || (data.dsize % 4 != 0))
696 job_count = data.dsize / 4;
697 for (i = 0; i < job_count; i++) {
700 ch_jobid = IVAL(data.dptr, i*4);
701 if (ch_jobid == jobid) {
702 if (i < job_count -1 )
703 memmove(data.dptr + (i*4), data.dptr + (i*4) + 4, (job_count - i - 1)*4 );
705 if (tdb_store(pdb->tdb, key, data, TDB_REPLACE) != 0)
715 tdb_chainunlock(pdb->tdb, key);
716 SAFE_FREE(data.dptr);
717 release_print_db(pdb);
719 DEBUG(10,("remove_from_jobs_changed: removed jobid %u\n", (unsigned int)jobid ));
721 DEBUG(10,("remove_from_jobs_changed: Failed to remove jobid %u\n", (unsigned int)jobid ));
725 static void pjob_store_notify(struct tevent_context *ev,
726 struct messaging_context *msg_ctx,
727 const char* sharename, uint32_t jobid,
728 struct printjob *old_data,
729 struct printjob *new_data,
732 bool new_job = false;
733 bool changed = false;
735 if (old_data == NULL) {
739 /* ACHTUNG! Due to a bug in Samba's spoolss parsing of the
740 NOTIFY_INFO_DATA buffer, we *have* to send the job submission
741 time first or else we'll end up with potential alignment
742 errors. I don't think the systemtime should be spooled as
743 a string, but this gets us around that error.
744 --jerry (i'll feel dirty for this) */
747 notify_job_submitted(ev, msg_ctx,
748 sharename, jobid, new_data->starttime);
749 notify_job_username(ev, msg_ctx,
750 sharename, jobid, new_data->user);
751 notify_job_name(ev, msg_ctx,
752 sharename, jobid, new_data->jobname);
753 notify_job_status(ev, msg_ctx,
754 sharename, jobid, map_to_spoolss_status(new_data->status));
755 notify_job_total_bytes(ev, msg_ctx,
756 sharename, jobid, new_data->size);
757 notify_job_total_pages(ev, msg_ctx,
758 sharename, jobid, new_data->page_count);
760 if (!strequal(old_data->jobname, new_data->jobname)) {
761 notify_job_name(ev, msg_ctx, sharename,
762 jobid, new_data->jobname);
766 if (old_data->status != new_data->status) {
767 notify_job_status(ev, msg_ctx,
769 map_to_spoolss_status(new_data->status));
772 if (old_data->size != new_data->size) {
773 notify_job_total_bytes(ev, msg_ctx,
774 sharename, jobid, new_data->size);
777 if (old_data->page_count != new_data->page_count) {
778 notify_job_total_pages(ev, msg_ctx,
780 new_data->page_count);
787 /****************************************************************************
788 Store a job structure back to the database.
789 ****************************************************************************/
791 static bool pjob_store(struct tevent_context *ev,
792 struct messaging_context *msg_ctx,
793 const char* sharename, uint32_t jobid,
794 struct printjob *pjob)
797 TDB_DATA old_data, new_data;
799 struct tdb_print_db *pdb = get_print_db_byname(sharename);
801 int len, newlen, buflen;
809 old_data = tdb_fetch(pdb->tdb, print_key(jobid, &tmp));
811 /* Doh! Now we have to pack/unpack data since the NT_DEVICEMODE was added */
818 len += tdb_pack(buf+len, buflen-len, "ddddddddddfffff",
820 (uint32_t)pjob->jobid,
821 (uint32_t)pjob->sysjob,
823 (uint32_t)pjob->starttime,
824 (uint32_t)pjob->status,
825 (uint32_t)pjob->size,
826 (uint32_t)pjob->page_count,
827 (uint32_t)pjob->spooled,
828 (uint32_t)pjob->smbjob,
835 len += pack_devicemode(pjob->devmode, buf+len, buflen-len);
838 buf = (uint8_t *)SMB_REALLOC(buf, len);
840 DEBUG(0,("pjob_store: failed to enlarge buffer!\n"));
845 } while ( buflen != len );
851 new_data.dsize = len;
852 ret = (tdb_store(pdb->tdb, print_key(jobid, &tmp), new_data,
855 /* Send notify updates for what has changed */
858 bool changed = false;
859 struct printjob old_pjob;
861 if (old_data.dsize) {
862 TALLOC_CTX *tmp_ctx = talloc_new(ev);
866 len = unpack_pjob(tmp_ctx, old_data.dptr,
867 old_data.dsize, &old_pjob);
869 pjob_store_notify(ev,
871 sharename, jobid, &old_pjob,
875 add_to_jobs_changed(pdb, jobid);
878 talloc_free(tmp_ctx);
882 pjob_store_notify(ev, msg_ctx,
883 sharename, jobid, NULL, pjob,
889 release_print_db(pdb);
890 SAFE_FREE( old_data.dptr );
896 /****************************************************************************
897 Remove a job structure from the database.
898 ****************************************************************************/
900 static void pjob_delete(struct tevent_context *ev,
901 struct messaging_context *msg_ctx,
902 const char* sharename, uint32_t jobid)
905 struct printjob *pjob;
906 uint32_t job_status = 0;
907 struct tdb_print_db *pdb;
908 TALLOC_CTX *tmp_ctx = talloc_new(ev);
909 if (tmp_ctx == NULL) {
913 pdb = get_print_db_byname(sharename);
918 pjob = print_job_find(tmp_ctx, sharename, jobid);
920 DEBUG(5, ("we were asked to delete nonexistent job %u\n",
925 /* We must cycle through JOB_STATUS_DELETING and
926 JOB_STATUS_DELETED for the port monitor to delete the job
929 job_status = JOB_STATUS_DELETING|JOB_STATUS_DELETED;
930 notify_job_status(ev, msg_ctx, sharename, jobid, job_status);
932 /* Remove from printing.tdb */
934 tdb_delete(pdb->tdb, print_key(jobid, &tmp));
935 remove_from_jobs_added(sharename, jobid);
936 rap_jobid_delete(sharename, jobid);
938 release_print_db(pdb);
940 talloc_free(tmp_ctx);
943 /****************************************************************************
944 List a unix job in the print database.
945 ****************************************************************************/
947 static void print_unix_job(struct tevent_context *ev,
948 struct messaging_context *msg_ctx,
949 const char *sharename, print_queue_struct *q,
952 struct printjob pj, *old_pj;
953 TALLOC_CTX *tmp_ctx = talloc_new(ev);
954 if (tmp_ctx == NULL) {
958 if (jobid == (uint32_t)-1) {
959 jobid = q->sysjob + UNIX_JOB_START;
962 /* Preserve the timestamp on an existing unix print job */
964 old_pj = print_job_find(tmp_ctx, sharename, jobid);
970 pj.sysjob = q->sysjob;
972 pj.starttime = old_pj ? old_pj->starttime : q->time;
973 pj.status = q->status;
976 fstrcpy(pj.filename, old_pj ? old_pj->filename : "");
977 if (jobid < UNIX_JOB_START) {
979 fstrcpy(pj.jobname, old_pj ? old_pj->jobname : "Remote Downlevel Document");
982 fstrcpy(pj.jobname, old_pj ? old_pj->jobname : q->fs_file);
984 fstrcpy(pj.user, old_pj ? old_pj->user : q->fs_user);
985 fstrcpy(pj.queuename, old_pj ? old_pj->queuename : sharename );
987 pjob_store(ev, msg_ctx, sharename, jobid, &pj);
988 talloc_free(tmp_ctx);
992 struct traverse_struct {
993 print_queue_struct *queue;
994 size_t qcount, snum, maxcount, total_jobs;
995 const char *sharename;
997 const char *lprm_command;
998 struct printif *print_if;
999 struct tevent_context *ev;
1000 struct messaging_context *msg_ctx;
1001 TALLOC_CTX *mem_ctx;
1004 /****************************************************************************
1005 Utility fn to delete any jobs that are no longer active.
1006 ****************************************************************************/
1008 static int traverse_fn_delete(TDB_CONTEXT *t, TDB_DATA key, TDB_DATA data, void *state)
1010 struct traverse_struct *ts = (struct traverse_struct *)state;
1011 struct printjob pjob;
1015 if ( key.dsize != sizeof(jobid) )
1018 if (unpack_pjob(ts->mem_ctx, data.dptr, data.dsize, &pjob) == -1)
1020 talloc_free(pjob.devmode);
1024 /* remove a unix job if it isn't in the system queue any more */
1025 for (i=0;i<ts->qcount;i++) {
1026 if (ts->queue[i].sysjob == pjob.sysjob) {
1030 if (i == ts->qcount) {
1031 DEBUG(10,("traverse_fn_delete: pjob %u deleted due to !smbjob\n",
1032 (unsigned int)jobid ));
1033 pjob_delete(ts->ev, ts->msg_ctx,
1034 ts->sharename, jobid);
1038 /* need to continue the the bottom of the function to
1039 save the correct attributes */
1042 /* maybe it hasn't been spooled yet */
1043 if (!pjob.spooled) {
1044 /* if a job is not spooled and the process doesn't
1045 exist then kill it. This cleans up after smbd
1047 if (!process_exists_by_pid(pjob.pid)) {
1048 DEBUG(10,("traverse_fn_delete: pjob %u deleted due to !process_exists (%u)\n",
1049 (unsigned int)jobid, (unsigned int)pjob.pid ));
1050 pjob_delete(ts->ev, ts->msg_ctx,
1051 ts->sharename, jobid);
1057 /* this check only makes sense for jobs submitted from Windows clients */
1060 for (i=0;i<ts->qcount;i++) {
1061 if ( pjob.status == LPQ_DELETED )
1064 if (ts->queue[i].sysjob == pjob.sysjob) {
1066 /* try to clean up any jobs that need to be deleted */
1068 if ( pjob.status == LPQ_DELETING ) {
1071 result = (*(ts->print_if->job_delete))(
1072 ts->sharename, ts->lprm_command, &pjob );
1074 if ( result != 0 ) {
1075 /* if we can't delete, then reset the job status */
1076 pjob.status = LPQ_QUEUED;
1077 pjob_store(ts->ev, ts->msg_ctx,
1078 ts->sharename, jobid, &pjob);
1081 /* if we deleted the job, the remove the tdb record */
1084 ts->sharename, jobid);
1085 pjob.status = LPQ_DELETED;
1095 /* The job isn't in the system queue - we have to assume it has
1096 completed, so delete the database entry. */
1098 if (i == ts->qcount) {
1100 /* A race can occur between the time a job is spooled and
1101 when it appears in the lpq output. This happens when
1102 the job is added to printing.tdb when another smbd
1103 running print_queue_update() has completed a lpq and
1104 is currently traversing the printing tdb and deleting jobs.
1105 Don't delete the job if it was submitted after the lpq_time. */
1107 if (pjob.starttime < ts->lpq_time) {
1108 DEBUG(10,("traverse_fn_delete: pjob %u deleted due to pjob.starttime (%u) < ts->lpq_time (%u)\n",
1109 (unsigned int)jobid,
1110 (unsigned int)pjob.starttime,
1111 (unsigned int)ts->lpq_time ));
1112 pjob_delete(ts->ev, ts->msg_ctx,
1113 ts->sharename, jobid);
1119 /* Save the pjob attributes we will store. */
1120 ts->queue[i].sysjob = pjob.sysjob;
1121 ts->queue[i].size = pjob.size;
1122 ts->queue[i].page_count = pjob.page_count;
1123 ts->queue[i].status = pjob.status;
1124 ts->queue[i].priority = 1;
1125 ts->queue[i].time = pjob.starttime;
1126 fstrcpy(ts->queue[i].fs_user, pjob.user);
1127 fstrcpy(ts->queue[i].fs_file, pjob.jobname);
1134 /****************************************************************************
1135 Check if the print queue has been updated recently enough.
1136 ****************************************************************************/
1138 static void print_cache_flush(const char *sharename)
1141 struct tdb_print_db *pdb = get_print_db_byname(sharename);
1145 slprintf(key, sizeof(key)-1, "CACHE/%s", sharename);
1146 tdb_store_int32(pdb->tdb, key, -1);
1147 release_print_db(pdb);
1150 /****************************************************************************
1151 Check if someone already thinks they are doing the update.
1152 ****************************************************************************/
1154 static pid_t get_updating_pid(const char *sharename)
1159 struct tdb_print_db *pdb = get_print_db_byname(sharename);
1163 slprintf(keystr, sizeof(keystr)-1, "UPDATING/%s", sharename);
1164 key = string_tdb_data(keystr);
1166 data = tdb_fetch(pdb->tdb, key);
1167 release_print_db(pdb);
1168 if (!data.dptr || data.dsize != sizeof(pid_t)) {
1169 SAFE_FREE(data.dptr);
1173 updating_pid = IVAL(data.dptr, 0);
1174 SAFE_FREE(data.dptr);
1176 if (process_exists_by_pid(updating_pid))
1177 return updating_pid;
1182 /****************************************************************************
1183 Set the fact that we're doing the update, or have finished doing the update
1185 ****************************************************************************/
1187 static void set_updating_pid(const fstring sharename, bool updating)
1192 pid_t updating_pid = getpid();
1195 struct tdb_print_db *pdb = get_print_db_byname(sharename);
1200 slprintf(keystr, sizeof(keystr)-1, "UPDATING/%s", sharename);
1201 key = string_tdb_data(keystr);
1203 DEBUG(5, ("set_updating_pid: %supdating lpq cache for print share %s\n",
1204 updating ? "" : "not ",
1208 tdb_delete(pdb->tdb, key);
1209 release_print_db(pdb);
1213 SIVAL( buffer, 0, updating_pid);
1215 data.dsize = 4; /* we always assume this is a 4 byte value */
1217 tdb_store(pdb->tdb, key, data, TDB_REPLACE);
1218 release_print_db(pdb);
1221 /****************************************************************************
1222 Sort print jobs by submittal time.
1223 ****************************************************************************/
1225 static int printjob_comp(print_queue_struct *j1, print_queue_struct *j2)
1236 /* Sort on job start time */
1238 if (j1->time == j2->time)
1240 return (j1->time > j2->time) ? 1 : -1;
1243 /****************************************************************************
1244 Store the sorted queue representation for later portmon retrieval.
1246 ****************************************************************************/
1248 static void store_queue_struct(struct tdb_print_db *pdb, struct traverse_struct *pts)
1251 int max_reported_jobs = lp_max_reported_print_jobs(pts->snum);
1252 print_queue_struct *queue = pts->queue;
1255 unsigned int qcount;
1257 if (max_reported_jobs && (max_reported_jobs < pts->qcount))
1258 pts->qcount = max_reported_jobs;
1261 /* Work out the size. */
1263 data.dsize += tdb_pack(NULL, 0, "d", qcount);
1265 for (i = 0; i < pts->qcount; i++) {
1266 if ( queue[i].status == LPQ_DELETED )
1270 data.dsize += tdb_pack(NULL, 0, "ddddddff",
1271 (uint32_t)queue[i].sysjob,
1272 (uint32_t)queue[i].size,
1273 (uint32_t)queue[i].page_count,
1274 (uint32_t)queue[i].status,
1275 (uint32_t)queue[i].priority,
1276 (uint32_t)queue[i].time,
1281 if ((data.dptr = (uint8_t *)SMB_MALLOC(data.dsize)) == NULL)
1285 len += tdb_pack(data.dptr + len, data.dsize - len, "d", qcount);
1286 for (i = 0; i < pts->qcount; i++) {
1287 if ( queue[i].status == LPQ_DELETED )
1290 len += tdb_pack(data.dptr + len, data.dsize - len, "ddddddff",
1291 (uint32_t)queue[i].sysjob,
1292 (uint32_t)queue[i].size,
1293 (uint32_t)queue[i].page_count,
1294 (uint32_t)queue[i].status,
1295 (uint32_t)queue[i].priority,
1296 (uint32_t)queue[i].time,
1301 tdb_store(pdb->tdb, string_tdb_data("INFO/linear_queue_array"), data,
1303 SAFE_FREE(data.dptr);
1307 static TDB_DATA get_jobs_added_data(struct tdb_print_db *pdb)
1313 data = tdb_fetch(pdb->tdb, string_tdb_data("INFO/jobs_added"));
1314 if (data.dptr == NULL || data.dsize == 0 || (data.dsize % 4 != 0)) {
1315 SAFE_FREE(data.dptr);
1322 static void check_job_added(const char *sharename, TDB_DATA data, uint32_t jobid)
1325 unsigned int job_count = data.dsize / 4;
1327 for (i = 0; i < job_count; i++) {
1330 ch_jobid = IVAL(data.dptr, i*4);
1331 if (ch_jobid == jobid)
1332 remove_from_jobs_added(sharename, jobid);
1336 /****************************************************************************
1337 Check if the print queue has been updated recently enough.
1338 ****************************************************************************/
1340 static bool print_cache_expired(const char *sharename, bool check_pending)
1343 time_t last_qscan_time, time_now = time(NULL);
1344 struct tdb_print_db *pdb = get_print_db_byname(sharename);
1345 bool result = False;
1350 snprintf(key, sizeof(key), "CACHE/%s", sharename);
1351 last_qscan_time = (time_t)tdb_fetch_int32(pdb->tdb, key);
1354 * Invalidate the queue for 3 reasons.
1355 * (1). last queue scan time == -1.
1356 * (2). Current time - last queue scan time > allowed cache time.
1357 * (3). last queue scan time > current time + MAX_CACHE_VALID_TIME (1 hour by default).
1358 * This last test picks up machines for which the clock has been moved
1359 * forward, an lpq scan done and then the clock moved back. Otherwise
1360 * that last lpq scan would stay around for a loooong loooong time... :-). JRA.
1363 if (last_qscan_time == ((time_t)-1)
1364 || (time_now - last_qscan_time) >= lp_lpq_cache_time()
1365 || last_qscan_time > (time_now + MAX_CACHE_VALID_TIME))
1368 time_t msg_pending_time;
1370 DEBUG(4, ("print_cache_expired: cache expired for queue %s "
1371 "(last_qscan_time = %d, time now = %d, qcachetime = %d)\n",
1372 sharename, (int)last_qscan_time, (int)time_now,
1373 (int)lp_lpq_cache_time() ));
1375 /* check if another smbd has already sent a message to update the
1376 queue. Give the pending message one minute to clear and
1377 then send another message anyways. Make sure to check for
1378 clocks that have been run forward and then back again. */
1380 snprintf(key, sizeof(key), "MSG_PENDING/%s", sharename);
1383 && tdb_fetch_uint32( pdb->tdb, key, &u )
1384 && (msg_pending_time=u) > 0
1385 && msg_pending_time <= time_now
1386 && (time_now - msg_pending_time) < 60 )
1388 DEBUG(4,("print_cache_expired: message already pending for %s. Accepting cache\n",
1397 release_print_db(pdb);
1401 /****************************************************************************
1402 main work for updating the lpq cache for a printer queue
1403 ****************************************************************************/
1405 static void print_queue_update_internal(struct tevent_context *ev,
1406 struct messaging_context *msg_ctx,
1407 const char *sharename,
1408 struct printif *current_printif,
1409 char *lpq_command, char *lprm_command)
1412 print_queue_struct *queue = NULL;
1413 print_status_struct status;
1414 print_status_struct old_status;
1415 struct printjob *pjob;
1416 struct traverse_struct tstruct;
1419 fstring keystr, cachestr;
1420 struct tdb_print_db *pdb = get_print_db_byname(sharename);
1421 TALLOC_CTX *tmp_ctx = talloc_new(ev);
1423 if ((pdb == NULL) || (tmp_ctx == NULL)) {
1427 DEBUG(5,("print_queue_update_internal: printer = %s, type = %d, lpq command = [%s]\n",
1428 sharename, current_printif->type, lpq_command));
1431 * Update the cache time FIRST ! Stops others even
1432 * attempting to get the lock and doing this
1433 * if the lpq takes a long time.
1436 slprintf(cachestr, sizeof(cachestr)-1, "CACHE/%s", sharename);
1437 tdb_store_int32(pdb->tdb, cachestr, (int)time(NULL));
1439 /* get the current queue using the appropriate interface */
1440 ZERO_STRUCT(status);
1442 qcount = (*(current_printif->queue_get))(sharename,
1443 current_printif->type,
1444 lpq_command, &queue, &status);
1446 DBG_NOTICE("%zu job%s in queue for %s\n",
1448 (qcount != 1) ? "s" : "",
1451 /* Sort the queue by submission time otherwise they are displayed
1454 TYPESAFE_QSORT(queue, qcount, printjob_comp);
1457 any job in the internal database that is marked as spooled
1458 and doesn't exist in the system queue is considered finished
1459 and removed from the database
1461 any job in the system database but not in the internal database
1462 is added as a unix job
1464 fill in any system job numbers as we go
1466 jcdata = get_jobs_added_data(pdb);
1468 for (i=0; i<qcount; i++) {
1469 uint32_t jobid = sysjob_to_jobid_pdb(pdb, queue[i].sysjob);
1470 if (jobid == (uint32_t)-1) {
1471 /* assume its a unix print job */
1472 print_unix_job(ev, msg_ctx,
1473 sharename, &queue[i], jobid);
1477 /* we have an active SMB print job - update its status */
1478 pjob = print_job_find(tmp_ctx, sharename, jobid);
1480 /* err, somethings wrong. Probably smbd was restarted
1481 with jobs in the queue. All we can do is treat them
1482 like unix jobs. Pity. */
1483 DEBUG(1, ("queued print job %d not found in jobs list, "
1484 "assuming unix job\n", jobid));
1485 print_unix_job(ev, msg_ctx,
1486 sharename, &queue[i], jobid);
1490 /* don't reset the status on jobs to be deleted */
1492 if ( pjob->status != LPQ_DELETING )
1493 pjob->status = queue[i].status;
1495 pjob_store(ev, msg_ctx, sharename, jobid, pjob);
1497 check_job_added(sharename, jcdata, jobid);
1500 SAFE_FREE(jcdata.dptr);
1502 /* now delete any queued entries that don't appear in the
1504 tstruct.queue = queue;
1505 tstruct.qcount = qcount;
1507 tstruct.total_jobs = 0;
1508 tstruct.lpq_time = time(NULL);
1509 tstruct.sharename = sharename;
1510 tstruct.lprm_command = lprm_command;
1511 tstruct.print_if = current_printif;
1513 tstruct.msg_ctx = msg_ctx;
1514 tstruct.mem_ctx = tmp_ctx;
1516 tdb_traverse(pdb->tdb, traverse_fn_delete, (void *)&tstruct);
1518 /* Store the linearised queue, max jobs only. */
1519 store_queue_struct(pdb, &tstruct);
1521 SAFE_FREE(tstruct.queue);
1522 talloc_free(tmp_ctx);
1524 DBG_DEBUG("printer %s INFO, total_jobs = %zu\n",
1526 tstruct.total_jobs);
1528 tdb_store_int32(pdb->tdb, "INFO/total_jobs", tstruct.total_jobs);
1530 get_queue_status(sharename, &old_status);
1531 if (old_status.qcount != qcount) {
1532 DBG_DEBUG("Queue status change %zu jobs -> %zu jobs "
1539 /* store the new queue status structure */
1540 slprintf(keystr, sizeof(keystr)-1, "STATUS/%s", sharename);
1541 key = string_tdb_data(keystr);
1543 status.qcount = qcount;
1544 data.dptr = (uint8_t *)&status;
1545 data.dsize = sizeof(status);
1546 tdb_store(pdb->tdb, key, data, TDB_REPLACE);
1549 * Update the cache time again. We want to do this call
1550 * as little as possible...
1553 slprintf(keystr, sizeof(keystr)-1, "CACHE/%s", sharename);
1554 tdb_store_int32(pdb->tdb, keystr, (int32_t)time(NULL));
1556 /* clear the msg pending record for this queue */
1558 snprintf(keystr, sizeof(keystr), "MSG_PENDING/%s", sharename);
1560 if ( !tdb_store_uint32( pdb->tdb, keystr, 0 ) ) {
1561 /* log a message but continue on */
1563 DEBUG(0,("print_queue_update: failed to store MSG_PENDING flag for [%s]!\n",
1567 release_print_db( pdb );
1572 /****************************************************************************
1573 Update the internal database from the system print queue for a queue.
1574 obtain a lock on the print queue before proceeding (needed when mutiple
1575 smbd processes maytry to update the lpq cache concurrently).
1576 ****************************************************************************/
1578 static void print_queue_update_with_lock( struct tevent_context *ev,
1579 struct messaging_context *msg_ctx,
1580 const char *sharename,
1581 struct printif *current_printif,
1582 char *lpq_command, char *lprm_command )
1585 struct tdb_print_db *pdb;
1587 DEBUG(5,("print_queue_update_with_lock: printer share = %s\n", sharename));
1588 pdb = get_print_db_byname(sharename);
1592 if ( !print_cache_expired(sharename, False) ) {
1593 DEBUG(5,("print_queue_update_with_lock: print cache for %s is still ok\n", sharename));
1594 release_print_db(pdb);
1599 * Check to see if someone else is doing this update.
1600 * This is essentially a mutex on the update.
1603 if (get_updating_pid(sharename) != -1) {
1604 release_print_db(pdb);
1608 /* Lock the queue for the database update */
1610 slprintf(keystr, sizeof(keystr) - 1, "LOCK/%s", sharename);
1611 /* Only wait 10 seconds for this. */
1612 if (tdb_lock_bystring_with_timeout(pdb->tdb, keystr, 10) != 0) {
1613 DEBUG(0,("print_queue_update_with_lock: Failed to lock printer %s database\n", sharename));
1614 release_print_db(pdb);
1619 * Ensure that no one else got in here.
1620 * If the updating pid is still -1 then we are
1624 if (get_updating_pid(sharename) != -1) {
1626 * Someone else is doing the update, exit.
1628 tdb_unlock_bystring(pdb->tdb, keystr);
1629 release_print_db(pdb);
1634 * We're going to do the update ourselves.
1637 /* Tell others we're doing the update. */
1638 set_updating_pid(sharename, True);
1641 * Allow others to enter and notice we're doing
1645 tdb_unlock_bystring(pdb->tdb, keystr);
1647 /* do the main work now */
1649 print_queue_update_internal(ev, msg_ctx,
1650 sharename, current_printif,
1651 lpq_command, lprm_command);
1653 /* Delete our pid from the db. */
1654 set_updating_pid(sharename, False);
1655 release_print_db(pdb);
1658 /****************************************************************************
1659 this is the receive function of the background lpq updater
1660 ****************************************************************************/
1661 void print_queue_receive(struct messaging_context *msg,
1664 struct server_id server_id,
1668 char *lpqcommand = NULL, *lprmcommand = NULL;
1672 len = tdb_unpack( (uint8_t *)data->data, data->length, "fdPP",
1679 SAFE_FREE(lpqcommand);
1680 SAFE_FREE(lprmcommand);
1681 DEBUG(0,("print_queue_receive: Got invalid print queue update message\n"));
1685 print_queue_update_with_lock(global_event_context(), msg, sharename,
1686 get_printer_fns_from_type((enum printing_types)printing_type),
1687 lpqcommand, lprmcommand );
1689 SAFE_FREE(lpqcommand);
1690 SAFE_FREE(lprmcommand);
1694 /****************************************************************************
1695 update the internal database from the system print queue for a queue
1696 ****************************************************************************/
1698 extern pid_t background_lpq_updater_pid;
1700 static void print_queue_update(struct messaging_context *msg_ctx,
1701 int snum, bool force)
1705 char *lpqcommand = NULL;
1706 char *lprmcommand = NULL;
1707 uint8_t *buffer = NULL;
1710 struct tdb_print_db *pdb;
1712 struct printif *current_printif;
1713 TALLOC_CTX *ctx = talloc_tos();
1714 const struct loadparm_substitution *lp_sub =
1715 loadparm_s3_global_substitution();
1717 fstrcpy( sharename, lp_const_servicename(snum));
1719 /* don't strip out characters like '$' from the printername */
1721 lpqcommand = talloc_string_sub2(ctx,
1722 lp_lpq_command(snum),
1724 lp_printername(talloc_tos(), lp_sub, snum),
1725 false, false, false);
1729 lpqcommand = talloc_sub_full(ctx,
1730 lp_servicename(talloc_tos(), lp_sub, snum),
1731 current_user_info.unix_name,
1733 get_current_gid(NULL),
1734 get_current_username(),
1735 current_user_info.domain,
1741 lprmcommand = talloc_string_sub2(ctx,
1742 lp_lprm_command(snum),
1744 lp_printername(talloc_tos(), lp_sub, snum),
1745 false, false, false);
1749 lprmcommand = talloc_sub_full(ctx,
1750 lp_servicename(talloc_tos(), lp_sub, snum),
1751 current_user_info.unix_name,
1753 get_current_gid(NULL),
1754 get_current_username(),
1755 current_user_info.domain,
1762 * Make sure that the background queue process exists.
1763 * Otherwise just do the update ourselves
1766 if ( force || background_lpq_updater_pid == -1 ) {
1767 DEBUG(4,("print_queue_update: updating queue [%s] myself\n", sharename));
1768 current_printif = get_printer_fns( snum );
1769 print_queue_update_with_lock(global_event_context(), msg_ctx,
1770 sharename, current_printif,
1771 lpqcommand, lprmcommand);
1776 type = lp_printing(snum);
1778 /* get the length */
1780 len = tdb_pack( NULL, 0, "fdPP",
1786 buffer = SMB_XMALLOC_ARRAY( uint8_t, len );
1788 /* now pack the buffer */
1789 newlen = tdb_pack( buffer, len, "fdPP",
1795 SMB_ASSERT( newlen == len );
1797 DEBUG(10,("print_queue_update: Sending message -> printer = %s, "
1798 "type = %d, lpq command = [%s] lprm command = [%s]\n",
1799 sharename, type, lpqcommand, lprmcommand ));
1801 /* here we set a msg pending record for other smbd processes
1802 to throttle the number of duplicate print_queue_update msgs
1805 pdb = get_print_db_byname(sharename);
1811 snprintf(key, sizeof(key), "MSG_PENDING/%s", sharename);
1813 if ( !tdb_store_uint32( pdb->tdb, key, time(NULL) ) ) {
1814 /* log a message but continue on */
1816 DEBUG(0,("print_queue_update: failed to store MSG_PENDING flag for [%s]!\n",
1820 release_print_db( pdb );
1822 /* finally send the message */
1824 messaging_send_buf(msg_ctx, pid_to_procid(background_lpq_updater_pid),
1825 MSG_PRINTER_UPDATE, (uint8_t *)buffer, len);
1827 SAFE_FREE( buffer );
1832 /****************************************************************************
1833 Create/Update an entry in the print tdb that will allow us to send notify
1834 updates only to interested smbd's.
1835 ****************************************************************************/
1837 bool print_notify_register_pid(int snum)
1840 struct tdb_print_db *pdb = NULL;
1841 TDB_CONTEXT *tdb = NULL;
1842 const char *printername;
1843 uint32_t mypid = (uint32_t)getpid();
1847 /* if (snum == -1), then the change notify request was
1848 on a print server handle and we need to register on
1853 int num_services = lp_numservices();
1856 for ( idx=0; idx<num_services; idx++ ) {
1857 if (lp_snum_ok(idx) && lp_printable(idx) )
1858 print_notify_register_pid(idx);
1863 else /* register for a specific printer */
1865 printername = lp_const_servicename(snum);
1866 pdb = get_print_db_byname(printername);
1872 if (tdb_lock_bystring_with_timeout(tdb, NOTIFY_PID_LIST_KEY, 10) != 0) {
1873 DEBUG(0,("print_notify_register_pid: Failed to lock printer %s\n",
1876 release_print_db(pdb);
1880 data = get_printer_notify_pid_list( tdb, printername, True );
1882 /* Add ourselves and increase the refcount. */
1884 for (i = 0; i < data.dsize; i += 8) {
1885 if (IVAL(data.dptr,i) == mypid) {
1886 uint32_t new_refcount = IVAL(data.dptr, i+4) + 1;
1887 SIVAL(data.dptr, i+4, new_refcount);
1892 if (i == data.dsize) {
1893 /* We weren't in the list. Realloc. */
1894 data.dptr = (uint8_t *)SMB_REALLOC(data.dptr, data.dsize + 8);
1896 DEBUG(0,("print_notify_register_pid: Relloc fail for printer %s\n",
1901 SIVAL(data.dptr,data.dsize - 8,mypid);
1902 SIVAL(data.dptr,data.dsize - 4,1); /* Refcount. */
1905 /* Store back the record. */
1906 if (tdb_store_bystring(tdb, NOTIFY_PID_LIST_KEY, data, TDB_REPLACE) != 0) {
1907 DEBUG(0,("print_notify_register_pid: Failed to update pid \
1908 list for printer %s\n", printername));
1916 tdb_unlock_bystring(tdb, NOTIFY_PID_LIST_KEY);
1918 release_print_db(pdb);
1919 SAFE_FREE(data.dptr);
1923 /****************************************************************************
1924 Update an entry in the print tdb that will allow us to send notify
1925 updates only to interested smbd's.
1926 ****************************************************************************/
1928 bool print_notify_deregister_pid(int snum)
1931 struct tdb_print_db *pdb = NULL;
1932 TDB_CONTEXT *tdb = NULL;
1933 const char *printername;
1934 uint32_t mypid = (uint32_t)getpid();
1938 /* if ( snum == -1 ), we are deregister a print server handle
1939 which means to deregister on all print queues */
1943 int num_services = lp_numservices();
1946 for ( idx=0; idx<num_services; idx++ ) {
1947 if ( lp_snum_ok(idx) && lp_printable(idx) )
1948 print_notify_deregister_pid(idx);
1953 else /* deregister a specific printer */
1955 printername = lp_const_servicename(snum);
1956 pdb = get_print_db_byname(printername);
1962 if (tdb_lock_bystring_with_timeout(tdb, NOTIFY_PID_LIST_KEY, 10) != 0) {
1963 DEBUG(0,("print_notify_register_pid: Failed to lock \
1964 printer %s database\n", printername));
1966 release_print_db(pdb);
1970 data = get_printer_notify_pid_list( tdb, printername, True );
1972 /* Reduce refcount. Remove ourselves if zero. */
1974 for (i = 0; i < data.dsize; ) {
1975 if (IVAL(data.dptr,i) == mypid) {
1976 uint32_t refcount = IVAL(data.dptr, i+4);
1980 if (refcount == 0) {
1981 if (data.dsize - i > 8)
1982 memmove( &data.dptr[i], &data.dptr[i+8], data.dsize - i - 8);
1986 SIVAL(data.dptr, i+4, refcount);
1992 if (data.dsize == 0)
1993 SAFE_FREE(data.dptr);
1995 /* Store back the record. */
1996 if (tdb_store_bystring(tdb, NOTIFY_PID_LIST_KEY, data, TDB_REPLACE) != 0) {
1997 DEBUG(0,("print_notify_register_pid: Failed to update pid \
1998 list for printer %s\n", printername));
2006 tdb_unlock_bystring(tdb, NOTIFY_PID_LIST_KEY);
2008 release_print_db(pdb);
2009 SAFE_FREE(data.dptr);
2013 /****************************************************************************
2014 Check if a jobid is valid. It is valid if it exists in the database.
2015 ****************************************************************************/
2017 bool print_job_exists(const char* sharename, uint32_t jobid)
2019 struct tdb_print_db *pdb = get_print_db_byname(sharename);
2025 ret = tdb_exists(pdb->tdb, print_key(jobid, &tmp));
2026 release_print_db(pdb);
2030 /****************************************************************************
2031 Return the device mode asigned to a specific print job.
2032 Only valid for the process doing the spooling and when the job
2033 has not been spooled.
2034 ****************************************************************************/
2036 struct spoolss_DeviceMode *print_job_devmode(TALLOC_CTX *mem_ctx,
2037 const char *sharename,
2040 struct printjob *pjob = print_job_find(mem_ctx, sharename, jobid);
2045 return pjob->devmode;
2048 /****************************************************************************
2049 Set the name of a job. Only possible for owner.
2050 ****************************************************************************/
2052 bool print_job_set_name(struct tevent_context *ev,
2053 struct messaging_context *msg_ctx,
2054 const char *sharename, uint32_t jobid, const char *name)
2056 struct printjob *pjob;
2058 TALLOC_CTX *tmp_ctx = talloc_new(ev);
2059 if (tmp_ctx == NULL) {
2063 pjob = print_job_find(tmp_ctx, sharename, jobid);
2064 if (!pjob || pjob->pid != getpid()) {
2069 fstrcpy(pjob->jobname, name);
2070 ret = pjob_store(ev, msg_ctx, sharename, jobid, pjob);
2072 talloc_free(tmp_ctx);
2076 /****************************************************************************
2077 Get the name of a job. Only possible for owner.
2078 ****************************************************************************/
2080 bool print_job_get_name(TALLOC_CTX *mem_ctx, const char *sharename, uint32_t jobid, char **name)
2082 struct printjob *pjob;
2084 pjob = print_job_find(mem_ctx, sharename, jobid);
2085 if (!pjob || pjob->pid != getpid()) {
2089 *name = pjob->jobname;
2094 /***************************************************************************
2095 Remove a jobid from the 'jobs added' list.
2096 ***************************************************************************/
2098 static bool remove_from_jobs_added(const char* sharename, uint32_t jobid)
2100 struct tdb_print_db *pdb = get_print_db_byname(sharename);
2102 size_t job_count, i;
2104 bool gotlock = False;
2112 key = string_tdb_data("INFO/jobs_added");
2114 if (tdb_chainlock_with_timeout(pdb->tdb, key, 5) != 0)
2119 data = tdb_fetch(pdb->tdb, key);
2121 if (data.dptr == NULL || data.dsize == 0 || (data.dsize % 4 != 0))
2124 job_count = data.dsize / 4;
2125 for (i = 0; i < job_count; i++) {
2128 ch_jobid = IVAL(data.dptr, i*4);
2129 if (ch_jobid == jobid) {
2130 if (i < job_count -1 )
2131 memmove(data.dptr + (i*4), data.dptr + (i*4) + 4, (job_count - i - 1)*4 );
2133 if (tdb_store(pdb->tdb, key, data, TDB_REPLACE) != 0)
2143 tdb_chainunlock(pdb->tdb, key);
2144 SAFE_FREE(data.dptr);
2145 release_print_db(pdb);
2147 DEBUG(10,("remove_from_jobs_added: removed jobid %u\n", (unsigned int)jobid ));
2149 DEBUG(10,("remove_from_jobs_added: Failed to remove jobid %u\n", (unsigned int)jobid ));
2153 /****************************************************************************
2154 Delete a print job - don't update queue.
2155 ****************************************************************************/
2157 static bool print_job_delete1(struct tevent_context *ev,
2158 struct messaging_context *msg_ctx,
2159 int snum, uint32_t jobid)
2161 const char* sharename = lp_const_servicename(snum);
2162 const struct loadparm_substitution *lp_sub =
2163 loadparm_s3_global_substitution();
2164 struct printjob *pjob;
2166 struct printif *current_printif = get_printer_fns( snum );
2168 TALLOC_CTX *tmp_ctx = talloc_new(ev);
2169 if (tmp_ctx == NULL) {
2173 pjob = print_job_find(tmp_ctx, sharename, jobid);
2180 * If already deleting just return.
2183 if (pjob->status == LPQ_DELETING) {
2188 /* Hrm - we need to be able to cope with deleting a job before it
2189 has reached the spooler. Just mark it as LPQ_DELETING and
2190 let the print_queue_update() code rmeove the record */
2193 if (pjob->sysjob == -1) {
2194 DEBUG(5, ("attempt to delete job %u not seen by lpr\n", (unsigned int)jobid));
2197 /* Set the tdb entry to be deleting. */
2199 pjob->status = LPQ_DELETING;
2200 pjob_store(ev, msg_ctx, sharename, jobid, pjob);
2202 if (pjob->spooled && pjob->sysjob != -1)
2204 result = (*(current_printif->job_delete))(
2205 lp_printername(talloc_tos(), lp_sub, snum),
2206 lp_lprm_command(snum),
2209 /* Delete the tdb entry if the delete succeeded or the job hasn't
2213 struct tdb_print_db *pdb = get_print_db_byname(sharename);
2220 pjob_delete(ev, msg_ctx, sharename, jobid);
2221 /* Ensure we keep a rough count of the number of total jobs... */
2222 tdb_change_int32_atomic(pdb->tdb, "INFO/total_jobs", &njobs, -1);
2223 release_print_db(pdb);
2227 remove_from_jobs_added( sharename, jobid );
2229 ret = (result == 0);
2231 talloc_free(tmp_ctx);
2235 /****************************************************************************
2236 Return true if the current user owns the print job.
2237 ****************************************************************************/
2239 static bool is_owner(const struct auth_session_info *server_info,
2240 const char *servicename,
2243 struct printjob *pjob;
2245 TALLOC_CTX *tmp_ctx = talloc_new(server_info);
2246 if (tmp_ctx == NULL) {
2250 pjob = print_job_find(tmp_ctx, servicename, jobid);
2251 if (!pjob || !server_info) {
2256 ret = strequal(pjob->user, server_info->unix_info->sanitized_username);
2258 talloc_free(tmp_ctx);
2262 /****************************************************************************
2264 ****************************************************************************/
2266 WERROR print_job_delete(const struct auth_session_info *server_info,
2267 struct messaging_context *msg_ctx,
2268 int snum, uint32_t jobid)
2270 const char* sharename = lp_const_servicename(snum);
2271 const struct loadparm_substitution *lp_sub =
2272 loadparm_s3_global_substitution();
2273 struct printjob *pjob;
2276 TALLOC_CTX *tmp_ctx = talloc_new(msg_ctx);
2277 if (tmp_ctx == NULL) {
2278 return WERR_NOT_ENOUGH_MEMORY;
2281 owner = is_owner(server_info, lp_const_servicename(snum), jobid);
2283 /* Check access against security descriptor or whether the user
2287 !W_ERROR_IS_OK(print_access_check(server_info, msg_ctx, snum,
2288 JOB_ACCESS_ADMINISTER))) {
2289 DEBUG(0, ("print job delete denied."
2290 "User name: %s, Printer name: %s.",
2291 uidtoname(server_info->unix_token->uid),
2292 lp_printername(tmp_ctx, lp_sub, snum)));
2294 werr = WERR_ACCESS_DENIED;
2299 * get the spooled filename of the print job
2300 * if this works, then the file has not been spooled
2301 * to the underlying print system. Just delete the
2302 * spool file & return.
2305 pjob = print_job_find(tmp_ctx, sharename, jobid);
2306 if (!pjob || pjob->spooled || pjob->pid != getpid()) {
2307 DEBUG(10, ("Skipping spool file removal for job %u\n", jobid));
2309 DEBUG(10, ("Removing spool file [%s]\n", pjob->filename));
2310 if (unlink(pjob->filename) == -1) {
2311 werr = map_werror_from_unix(errno);
2316 if (!print_job_delete1(global_event_context(), msg_ctx, snum, jobid)) {
2317 werr = WERR_ACCESS_DENIED;
2321 /* force update the database and say the delete failed if the
2324 print_queue_update(msg_ctx, snum, True);
2326 pjob = print_job_find(tmp_ctx, sharename, jobid);
2327 if (pjob && (pjob->status != LPQ_DELETING)) {
2328 werr = WERR_ACCESS_DENIED;
2331 werr = WERR_PRINTER_HAS_JOBS_QUEUED;
2334 talloc_free(tmp_ctx);
2338 /****************************************************************************
2340 ****************************************************************************/
2342 WERROR print_job_pause(const struct auth_session_info *server_info,
2343 struct messaging_context *msg_ctx,
2344 int snum, uint32_t jobid)
2346 const char* sharename = lp_const_servicename(snum);
2347 const struct loadparm_substitution *lp_sub =
2348 loadparm_s3_global_substitution();
2349 struct printjob *pjob;
2351 struct printif *current_printif = get_printer_fns( snum );
2353 TALLOC_CTX *tmp_ctx = talloc_new(msg_ctx);
2354 if (tmp_ctx == NULL) {
2355 return WERR_NOT_ENOUGH_MEMORY;
2358 pjob = print_job_find(tmp_ctx, sharename, jobid);
2359 if (!pjob || !server_info) {
2360 DEBUG(10, ("print_job_pause: no pjob or user for jobid %u\n",
2361 (unsigned int)jobid ));
2362 werr = WERR_INVALID_PARAMETER;
2366 if (!pjob->spooled || pjob->sysjob == -1) {
2367 DEBUG(10, ("print_job_pause: not spooled or bad sysjob = %d for jobid %u\n",
2368 (int)pjob->sysjob, (unsigned int)jobid ));
2369 werr = WERR_INVALID_PARAMETER;
2373 if (!is_owner(server_info, lp_const_servicename(snum), jobid) &&
2374 !W_ERROR_IS_OK(print_access_check(server_info, msg_ctx, snum,
2375 JOB_ACCESS_ADMINISTER))) {
2376 DEBUG(0, ("print job pause denied."
2377 "User name: %s, Printer name: %s.",
2378 uidtoname(server_info->unix_token->uid),
2379 lp_printername(tmp_ctx, lp_sub, snum)));
2381 werr = WERR_ACCESS_DENIED;
2385 /* need to pause the spooled entry */
2386 ret = (*(current_printif->job_pause))(snum, pjob);
2389 werr = WERR_INVALID_PARAMETER;
2393 /* force update the database */
2394 print_cache_flush(lp_const_servicename(snum));
2396 /* Send a printer notify message */
2398 notify_job_status(global_event_context(), msg_ctx, sharename, jobid,
2401 /* how do we tell if this succeeded? */
2404 talloc_free(tmp_ctx);
2408 /****************************************************************************
2410 ****************************************************************************/
2412 WERROR print_job_resume(const struct auth_session_info *server_info,
2413 struct messaging_context *msg_ctx,
2414 int snum, uint32_t jobid)
2416 const char *sharename = lp_const_servicename(snum);
2417 const struct loadparm_substitution *lp_sub =
2418 loadparm_s3_global_substitution();
2419 struct printjob *pjob;
2421 struct printif *current_printif = get_printer_fns( snum );
2423 TALLOC_CTX *tmp_ctx = talloc_new(msg_ctx);
2424 if (tmp_ctx == NULL)
2425 return WERR_NOT_ENOUGH_MEMORY;
2427 pjob = print_job_find(tmp_ctx, sharename, jobid);
2428 if (!pjob || !server_info) {
2429 DEBUG(10, ("print_job_resume: no pjob or user for jobid %u\n",
2430 (unsigned int)jobid ));
2431 werr = WERR_INVALID_PARAMETER;
2435 if (!pjob->spooled || pjob->sysjob == -1) {
2436 DEBUG(10, ("print_job_resume: not spooled or bad sysjob = %d for jobid %u\n",
2437 (int)pjob->sysjob, (unsigned int)jobid ));
2438 werr = WERR_INVALID_PARAMETER;
2442 if (!is_owner(server_info, lp_const_servicename(snum), jobid) &&
2443 !W_ERROR_IS_OK(print_access_check(server_info, msg_ctx, snum,
2444 JOB_ACCESS_ADMINISTER))) {
2445 DEBUG(0, ("print job resume denied."
2446 "User name: %s, Printer name: %s.",
2447 uidtoname(server_info->unix_token->uid),
2448 lp_printername(tmp_ctx, lp_sub, snum)));
2450 werr = WERR_ACCESS_DENIED;
2454 ret = (*(current_printif->job_resume))(snum, pjob);
2457 werr = WERR_INVALID_PARAMETER;
2461 /* force update the database */
2462 print_cache_flush(lp_const_servicename(snum));
2464 /* Send a printer notify message */
2466 notify_job_status(global_event_context(), msg_ctx, sharename, jobid,
2471 talloc_free(tmp_ctx);
2475 /****************************************************************************
2476 Write to a print file.
2477 ****************************************************************************/
2479 ssize_t print_job_write(struct tevent_context *ev,
2480 struct messaging_context *msg_ctx,
2481 int snum, uint32_t jobid, const char *buf, size_t size)
2483 const char* sharename = lp_const_servicename(snum);
2484 ssize_t return_code;
2485 struct printjob *pjob;
2486 TALLOC_CTX *tmp_ctx = talloc_new(ev);
2487 if (tmp_ctx == NULL) {
2491 pjob = print_job_find(tmp_ctx, sharename, jobid);
2497 /* don't allow another process to get this info - it is meaningless */
2498 if (pjob->pid != getpid()) {
2503 /* if SMBD is spooling this can't be allowed */
2504 if (pjob->status == PJOB_SMBD_SPOOLING) {
2509 return_code = write_data(pjob->fd, buf, size);
2510 if (return_code > 0) {
2512 pjob_store(ev, msg_ctx, sharename, jobid, pjob);
2515 talloc_free(tmp_ctx);
2519 /****************************************************************************
2520 Get the queue status - do not update if db is out of date.
2521 ****************************************************************************/
2523 static int get_queue_status(const char* sharename, print_status_struct *status)
2527 struct tdb_print_db *pdb = get_print_db_byname(sharename);
2531 ZERO_STRUCTP(status);
2538 fstr_sprintf(keystr, "STATUS/%s", sharename);
2539 data = tdb_fetch(pdb->tdb, string_tdb_data(keystr));
2541 if (data.dsize == sizeof(print_status_struct))
2542 /* this memcpy is ok since the status struct was
2543 not packed before storing it in the tdb */
2544 memcpy(status, data.dptr, sizeof(print_status_struct));
2545 SAFE_FREE(data.dptr);
2548 len = tdb_fetch_int32(pdb->tdb, "INFO/total_jobs");
2549 release_print_db(pdb);
2550 return (len == -1 ? 0 : len);
2553 /****************************************************************************
2554 Determine the number of jobs in a queue.
2555 ****************************************************************************/
2557 int print_queue_length(struct messaging_context *msg_ctx, int snum,
2558 print_status_struct *pstatus)
2560 const char* sharename = lp_const_servicename( snum );
2561 print_status_struct status;
2564 ZERO_STRUCT( status );
2566 /* make sure the database is up to date */
2567 if (print_cache_expired(lp_const_servicename(snum), True))
2568 print_queue_update(msg_ctx, snum, False);
2570 /* also fetch the queue status */
2571 memset(&status, 0, sizeof(status));
2572 len = get_queue_status(sharename, &status);
2580 /***************************************************************************
2581 Allocate a jobid. Hold the lock for as short a time as possible.
2582 ***************************************************************************/
2584 static WERROR allocate_print_jobid(struct tdb_print_db *pdb, int snum,
2585 const char *sharename, uint32_t *pjobid)
2589 enum TDB_ERROR terr;
2592 *pjobid = (uint32_t)-1;
2594 for (i = 0; i < 3; i++) {
2595 /* Lock the database - only wait 20 seconds. */
2596 ret = tdb_lock_bystring_with_timeout(pdb->tdb,
2597 "INFO/nextjob", 20);
2599 DEBUG(0, ("allocate_print_jobid: "
2600 "Failed to lock printing database %s\n",
2602 terr = tdb_error(pdb->tdb);
2603 return ntstatus_to_werror(map_nt_error_from_tdb(terr));
2606 if (!tdb_fetch_uint32(pdb->tdb, "INFO/nextjob", &jobid)) {
2607 terr = tdb_error(pdb->tdb);
2608 if (terr != TDB_ERR_NOEXIST) {
2609 DEBUG(0, ("allocate_print_jobid: "
2610 "Failed to fetch INFO/nextjob "
2611 "for print queue %s\n", sharename));
2612 tdb_unlock_bystring(pdb->tdb, "INFO/nextjob");
2613 return ntstatus_to_werror(map_nt_error_from_tdb(terr));
2615 DEBUG(10, ("allocate_print_jobid: "
2616 "No existing jobid in %s\n", sharename));
2620 DEBUG(10, ("allocate_print_jobid: "
2621 "Read jobid %u from %s\n", jobid, sharename));
2623 jobid = NEXT_JOBID(jobid);
2625 ret = tdb_store_int32(pdb->tdb, "INFO/nextjob", jobid);
2627 terr = tdb_error(pdb->tdb);
2628 DEBUG(3, ("allocate_print_jobid: "
2629 "Failed to store INFO/nextjob.\n"));
2630 tdb_unlock_bystring(pdb->tdb, "INFO/nextjob");
2631 return ntstatus_to_werror(map_nt_error_from_tdb(terr));
2634 /* We've finished with the INFO/nextjob lock. */
2635 tdb_unlock_bystring(pdb->tdb, "INFO/nextjob");
2637 if (!print_job_exists(sharename, jobid)) {
2640 DEBUG(10, ("allocate_print_jobid: "
2641 "Found jobid %u in %s\n", jobid, sharename));
2645 DEBUG(0, ("allocate_print_jobid: "
2646 "Failed to allocate a print job for queue %s\n",
2648 /* Probably full... */
2649 return WERR_NO_SPOOL_SPACE;
2652 /* Store a dummy placeholder. */
2658 if (tdb_store(pdb->tdb, print_key(jobid, &tmp), dum,
2660 DEBUG(3, ("allocate_print_jobid: "
2661 "jobid (%d) failed to store placeholder.\n",
2663 terr = tdb_error(pdb->tdb);
2664 return ntstatus_to_werror(map_nt_error_from_tdb(terr));
2672 /***************************************************************************
2673 Append a jobid to the 'jobs added' list.
2674 ***************************************************************************/
2676 static bool add_to_jobs_added(struct tdb_print_db *pdb, uint32_t jobid)
2679 uint32_t store_jobid;
2681 SIVAL(&store_jobid, 0, jobid);
2682 data.dptr = (uint8_t *)&store_jobid;
2685 DEBUG(10,("add_to_jobs_added: Added jobid %u\n", (unsigned int)jobid ));
2687 return (tdb_append(pdb->tdb, string_tdb_data("INFO/jobs_added"),
2692 /***************************************************************************
2693 Do all checks needed to determine if we can start a job.
2694 ***************************************************************************/
2696 static WERROR print_job_checks(const struct auth_session_info *server_info,
2697 struct messaging_context *msg_ctx,
2698 int snum, int *njobs)
2700 const char *sharename = lp_const_servicename(snum);
2701 const struct loadparm_substitution *lp_sub =
2702 loadparm_s3_global_substitution();
2703 uint64_t dspace, dsize;
2707 if (!W_ERROR_IS_OK(print_access_check(server_info, msg_ctx, snum,
2708 PRINTER_ACCESS_USE))) {
2709 DEBUG(3, ("print_job_checks: "
2710 "job start denied by security descriptor\n"));
2711 return WERR_ACCESS_DENIED;
2714 if (!print_time_access_check(server_info, msg_ctx, sharename)) {
2715 DEBUG(3, ("print_job_checks: "
2716 "job start denied by time check\n"));
2717 return WERR_ACCESS_DENIED;
2720 /* see if we have sufficient disk space */
2721 if (lp_min_print_space(snum)) {
2722 minspace = lp_min_print_space(snum);
2723 ret = sys_fsusage(lp_path(talloc_tos(), lp_sub, snum), &dspace, &dsize);
2724 if (ret == 0 && dspace < 2*minspace) {
2725 DEBUG(3, ("print_job_checks: "
2726 "disk space check failed.\n"));
2727 return WERR_NO_SPOOL_SPACE;
2731 /* for autoloaded printers, check that the printcap entry still exists */
2732 if (lp_autoloaded(snum) && !pcap_printername_ok(sharename)) {
2733 DEBUG(3, ("print_job_checks: printer name %s check failed.\n",
2735 return WERR_ACCESS_DENIED;
2738 /* Insure the maximum queue size is not violated */
2739 *njobs = print_queue_length(msg_ctx, snum, NULL);
2740 if (*njobs > lp_maxprintjobs(snum)) {
2741 DEBUG(3, ("print_job_checks: Queue %s number of jobs (%d) "
2742 "larger than max printjobs per queue (%d).\n",
2743 sharename, *njobs, lp_maxprintjobs(snum)));
2744 return WERR_NO_SPOOL_SPACE;
2750 /***************************************************************************
2752 ***************************************************************************/
2754 static WERROR print_job_spool_file(int snum, uint32_t jobid,
2755 const char *output_file,
2756 struct printjob *pjob)
2758 const struct loadparm_substitution *lp_sub =
2759 loadparm_s3_global_substitution();
2766 /* if this file is within the printer path, it means that smbd
2767 * is spooling it and will pass us control when it is finished.
2768 * Verify that the file name is ok, within path, and it is
2769 * already already there */
2771 path = lp_path(talloc_tos(), lp_sub, snum);
2773 if (strncmp(output_file, path, len) == 0 &&
2774 (output_file[len - 1] == '/' || output_file[len] == '/')) {
2776 /* verify path is not too long */
2777 if (strlen(output_file) >= sizeof(pjob->filename)) {
2778 return WERR_INVALID_NAME;
2781 /* verify that the file exists */
2782 if (sys_stat(output_file, &st, false) != 0) {
2783 return WERR_INVALID_NAME;
2786 fstrcpy(pjob->filename, output_file);
2788 DEBUG(3, ("print_job_spool_file:"
2789 "External spooling activated\n"));
2791 /* we do not open the file until spooling is done */
2793 pjob->status = PJOB_SMBD_SPOOLING;
2799 slprintf(pjob->filename, sizeof(pjob->filename)-1,
2800 "%s/%sXXXXXX", lp_path(talloc_tos(), lp_sub, snum),
2801 PRINT_SPOOL_PREFIX);
2802 mask = umask(S_IRWXO | S_IRWXG);
2803 pjob->fd = mkstemp(pjob->filename);
2806 if (pjob->fd == -1) {
2807 werr = map_werror_from_unix(errno);
2808 if (W_ERROR_EQUAL(werr, WERR_ACCESS_DENIED)) {
2809 /* Common setup error, force a report. */
2810 DEBUG(0, ("print_job_spool_file: "
2811 "insufficient permissions to open spool "
2812 "file %s.\n", pjob->filename));
2814 /* Normal case, report at level 3 and above. */
2815 DEBUG(3, ("print_job_spool_file: "
2816 "can't open spool file %s\n",
2825 /***************************************************************************
2826 Start spooling a job - return the jobid.
2827 ***************************************************************************/
2829 WERROR print_job_start(const struct auth_session_info *server_info,
2830 struct messaging_context *msg_ctx,
2831 const char *clientmachine,
2832 int snum, const char *docname, const char *filename,
2833 struct spoolss_DeviceMode *devmode, uint32_t *_jobid)
2836 char *path = NULL, *userstr = NULL;
2837 struct printjob pjob;
2838 const char *sharename = lp_const_servicename(snum);
2839 struct tdb_print_db *pdb = get_print_db_byname(sharename);
2840 const struct loadparm_substitution *lp_sub =
2841 loadparm_s3_global_substitution();
2846 return WERR_INTERNAL_DB_CORRUPTION;
2849 path = lp_path(talloc_tos(), lp_sub, snum);
2851 werr = print_job_checks(server_info, msg_ctx, snum, &njobs);
2852 if (!W_ERROR_IS_OK(werr)) {
2853 release_print_db(pdb);
2857 DEBUG(10, ("print_job_start: "
2858 "Queue %s number of jobs (%d), max printjobs = %d\n",
2859 sharename, njobs, lp_maxprintjobs(snum)));
2861 werr = allocate_print_jobid(pdb, snum, sharename, &jobid);
2862 if (!W_ERROR_IS_OK(werr)) {
2866 /* create the database entry */
2870 pjob.pid = getpid();
2874 pjob.starttime = time(NULL);
2875 pjob.status = LPQ_SPOOLING;
2877 pjob.spooled = False;
2879 pjob.devmode = devmode;
2881 fstrcpy(pjob.jobname, docname);
2883 fstrcpy(pjob.clientmachine, clientmachine);
2885 userstr = talloc_sub_full(talloc_tos(),
2887 server_info->unix_info->sanitized_username,
2888 path, server_info->unix_token->gid,
2889 server_info->unix_info->sanitized_username,
2890 server_info->info->domain_name,
2891 lp_printjob_username(snum));
2892 if (userstr == NULL) {
2893 werr = WERR_NOT_ENOUGH_MEMORY;
2896 strlcpy(pjob.user, userstr, sizeof(pjob.user));
2897 TALLOC_FREE(userstr);
2899 fstrcpy(pjob.queuename, lp_const_servicename(snum));
2901 /* we have a job entry - now create the spool file */
2902 werr = print_job_spool_file(snum, jobid, filename, &pjob);
2903 if (!W_ERROR_IS_OK(werr)) {
2907 pjob_store(global_event_context(), msg_ctx, sharename, jobid, &pjob);
2909 /* Update the 'jobs added' entry used by print_queue_status. */
2910 add_to_jobs_added(pdb, jobid);
2912 /* Ensure we keep a rough count of the number of total jobs... */
2913 tdb_change_int32_atomic(pdb->tdb, "INFO/total_jobs", &njobs, 1);
2915 release_print_db(pdb);
2922 pjob_delete(global_event_context(), msg_ctx, sharename, jobid);
2925 release_print_db(pdb);
2927 DEBUG(3, ("print_job_start: returning fail. "
2928 "Error = %s\n", win_errstr(werr)));
2932 /****************************************************************************
2933 Update the number of pages spooled to jobid
2934 ****************************************************************************/
2936 void print_job_endpage(struct messaging_context *msg_ctx,
2937 int snum, uint32_t jobid)
2939 const char* sharename = lp_const_servicename(snum);
2940 struct printjob *pjob;
2941 TALLOC_CTX *tmp_ctx = talloc_new(msg_ctx);
2942 if (tmp_ctx == NULL) {
2946 pjob = print_job_find(tmp_ctx, sharename, jobid);
2950 /* don't allow another process to get this info - it is meaningless */
2951 if (pjob->pid != getpid()) {
2956 pjob_store(global_event_context(), msg_ctx, sharename, jobid, pjob);
2958 talloc_free(tmp_ctx);
2961 /****************************************************************************
2962 Print a file - called on closing the file. This spools the job.
2963 If normal close is false then we're tearing down the jobs - treat as an
2965 ****************************************************************************/
2967 NTSTATUS print_job_end(struct messaging_context *msg_ctx, int snum,
2968 uint32_t jobid, enum file_close_type close_type)
2970 const char* sharename = lp_const_servicename(snum);
2971 const struct loadparm_substitution *lp_sub =
2972 loadparm_s3_global_substitution();
2973 struct printjob *pjob;
2975 SMB_STRUCT_STAT sbuf;
2976 struct printif *current_printif = get_printer_fns(snum);
2977 NTSTATUS status = NT_STATUS_UNSUCCESSFUL;
2979 TALLOC_CTX *tmp_ctx = talloc_new(msg_ctx);
2980 if (tmp_ctx == NULL) {
2981 return NT_STATUS_NO_MEMORY;
2984 pjob = print_job_find(tmp_ctx, sharename, jobid);
2986 status = NT_STATUS_PRINT_CANCELLED;
2990 if (pjob->spooled || pjob->pid != getpid()) {
2991 status = NT_STATUS_ACCESS_DENIED;
2995 if (close_type == NORMAL_CLOSE || close_type == SHUTDOWN_CLOSE) {
2996 if (pjob->status == PJOB_SMBD_SPOOLING) {
2997 /* take over the file now, smbd is done */
2998 if (sys_stat(pjob->filename, &sbuf, false) != 0) {
2999 status = map_nt_error_from_unix(errno);
3000 DEBUG(3, ("print_job_end: "
3001 "stat file failed for jobid %d\n",
3006 pjob->status = LPQ_SPOOLING;
3010 if ((sys_fstat(pjob->fd, &sbuf, false) != 0)) {
3011 status = map_nt_error_from_unix(errno);
3013 DEBUG(3, ("print_job_end: "
3014 "stat file failed for jobid %d\n",
3022 pjob->size = sbuf.st_ex_size;
3026 * Not a normal close, something has gone wrong. Cleanup.
3028 if (pjob->fd != -1) {
3034 /* Technically, this is not quite right. If the printer has a separator
3035 * page turned on, the NT spooler prints the separator page even if the
3036 * print job is 0 bytes. 010215 JRR */
3037 if (pjob->size == 0 || pjob->status == LPQ_DELETING) {
3038 /* don't bother spooling empty files or something being deleted. */
3039 DEBUG(5,("print_job_end: canceling spool of %s (%s)\n",
3040 pjob->filename, pjob->size ? "deleted" : "zero length" ));
3041 unlink(pjob->filename);
3042 pjob_delete(global_event_context(), msg_ctx, sharename, jobid);
3043 return NT_STATUS_OK;
3046 /* don't strip out characters like '$' from the printername */
3047 lpq_cmd = talloc_string_sub2(tmp_ctx,
3048 lp_lpq_command(snum),
3050 lp_printername(talloc_tos(), lp_sub, snum),
3051 false, false, false);
3052 if (lpq_cmd == NULL) {
3053 status = NT_STATUS_PRINT_CANCELLED;
3056 lpq_cmd = talloc_sub_full(tmp_ctx,
3057 lp_servicename(talloc_tos(), lp_sub, snum),
3058 current_user_info.unix_name,
3060 get_current_gid(NULL),
3061 get_current_username(),
3062 current_user_info.domain,
3064 if (lpq_cmd == NULL) {
3065 status = NT_STATUS_PRINT_CANCELLED;
3069 ret = (*(current_printif->job_submit))(snum, pjob,
3070 current_printif->type, lpq_cmd);
3072 status = NT_STATUS_PRINT_CANCELLED;
3076 /* The print job has been successfully handed over to the back-end */
3078 pjob->spooled = True;
3079 pjob->status = LPQ_QUEUED;
3080 pjob_store(global_event_context(), msg_ctx, sharename, jobid, pjob);
3082 /* make sure the database is up to date */
3083 if (print_cache_expired(lp_const_servicename(snum), True))
3084 print_queue_update(msg_ctx, snum, False);
3086 return NT_STATUS_OK;
3090 /* The print job was not successfully started. Cleanup */
3091 /* Still need to add proper error return propagation! 010122:JRR */
3093 unlink(pjob->filename);
3094 pjob_delete(global_event_context(), msg_ctx, sharename, jobid);
3096 talloc_free(tmp_ctx);
3100 /****************************************************************************
3101 Get a snapshot of jobs in the system without traversing.
3102 ****************************************************************************/
3104 static bool get_stored_queue_info(struct messaging_context *msg_ctx,
3105 struct tdb_print_db *pdb, int snum,
3106 int *pcount, print_queue_struct **ppqueue)
3108 const struct loadparm_substitution *lp_sub =
3109 loadparm_s3_global_substitution();
3110 TDB_DATA data, cgdata, jcdata;
3111 print_queue_struct *queue = NULL;
3112 uint32_t qcount = 0;
3113 uint32_t extra_count = 0;
3114 uint32_t changed_count = 0;
3115 int total_count = 0;
3118 int max_reported_jobs = lp_max_reported_print_jobs(snum);
3120 const char* sharename = lp_servicename(talloc_tos(), lp_sub, snum);
3121 TALLOC_CTX *tmp_ctx = talloc_new(msg_ctx);
3122 if (tmp_ctx == NULL) {
3126 /* make sure the database is up to date */
3127 if (print_cache_expired(lp_const_servicename(snum), True))
3128 print_queue_update(msg_ctx, snum, False);
3134 ZERO_STRUCT(cgdata);
3136 /* Get the stored queue data. */
3137 data = tdb_fetch(pdb->tdb, string_tdb_data("INFO/linear_queue_array"));
3139 if (data.dptr && data.dsize >= sizeof(qcount))
3140 len += tdb_unpack(data.dptr + len, data.dsize - len, "d", &qcount);
3142 /* Get the added jobs list. */
3143 cgdata = tdb_fetch(pdb->tdb, string_tdb_data("INFO/jobs_added"));
3144 if (cgdata.dptr != NULL && (cgdata.dsize % 4 == 0))
3145 extra_count = cgdata.dsize/4;
3147 /* Get the changed jobs list. */
3148 jcdata = tdb_fetch(pdb->tdb, string_tdb_data("INFO/jobs_changed"));
3149 if (jcdata.dptr != NULL && (jcdata.dsize % 4 == 0))
3150 changed_count = jcdata.dsize / 4;
3152 DEBUG(5,("get_stored_queue_info: qcount = %u, extra_count = %u\n", (unsigned int)qcount, (unsigned int)extra_count));
3154 /* Allocate the queue size. */
3155 if (qcount == 0 && extra_count == 0)
3158 if ((queue = SMB_MALLOC_ARRAY(print_queue_struct, qcount + extra_count)) == NULL)
3161 /* Retrieve the linearised queue data. */
3163 for(i = 0; i < qcount; i++) {
3164 uint32_t qjob, qsize, qpage_count, qstatus, qpriority, qtime;
3165 len += tdb_unpack(data.dptr + len, data.dsize - len, "ddddddff",
3174 queue[i].sysjob = qjob;
3175 queue[i].size = qsize;
3176 queue[i].page_count = qpage_count;
3177 queue[i].status = qstatus;
3178 queue[i].priority = qpriority;
3179 queue[i].time = qtime;
3182 total_count = qcount;
3184 /* Add new jobids to the queue. */
3185 for (i = 0; i < extra_count; i++) {
3187 struct printjob *pjob;
3189 jobid = IVAL(cgdata.dptr, i*4);
3190 DEBUG(5,("get_stored_queue_info: added job = %u\n", (unsigned int)jobid));
3191 pjob = print_job_find(tmp_ctx, lp_const_servicename(snum), jobid);
3193 DEBUG(5,("get_stored_queue_info: failed to find added job = %u\n", (unsigned int)jobid));
3194 remove_from_jobs_added(sharename, jobid);
3198 queue[total_count].sysjob = pjob->sysjob;
3199 queue[total_count].size = pjob->size;
3200 queue[total_count].page_count = pjob->page_count;
3201 queue[total_count].status = pjob->status;
3202 queue[total_count].priority = 1;
3203 queue[total_count].time = pjob->starttime;
3204 fstrcpy(queue[total_count].fs_user, pjob->user);
3205 fstrcpy(queue[total_count].fs_file, pjob->jobname);
3210 /* Update the changed jobids. */
3211 for (i = 0; i < changed_count; i++) {
3212 uint32_t jobid = IVAL(jcdata.dptr, i * 4);
3213 struct printjob *pjob;
3217 pjob = print_job_find(tmp_ctx, sharename, jobid);
3219 DEBUG(5,("get_stored_queue_info: failed to find "
3220 "changed job = %u\n",
3221 (unsigned int)jobid));
3222 remove_from_jobs_changed(sharename, jobid);
3226 for (j = 0; j < total_count; j++) {
3227 if (queue[j].sysjob == pjob->sysjob) {
3234 DEBUG(5,("get_stored_queue_info: changed job: %u\n",
3235 (unsigned int)jobid));
3237 queue[j].sysjob = pjob->sysjob;
3238 queue[j].size = pjob->size;
3239 queue[j].page_count = pjob->page_count;
3240 queue[j].status = pjob->status;
3241 queue[j].priority = 1;
3242 queue[j].time = pjob->starttime;
3243 fstrcpy(queue[j].fs_user, pjob->user);
3244 fstrcpy(queue[j].fs_file, pjob->jobname);
3247 DEBUG(5,("updated queue[%u], jobid: %u, sysjob: %u, "
3249 (unsigned int)j, (unsigned int)jobid,
3250 (unsigned int)queue[j].sysjob, pjob->jobname));
3253 remove_from_jobs_changed(sharename, jobid);
3256 /* Sort the queue by submission time otherwise they are displayed
3259 TYPESAFE_QSORT(queue, total_count, printjob_comp);
3261 DEBUG(5,("get_stored_queue_info: total_count = %u\n", (unsigned int)total_count));
3263 if (max_reported_jobs && total_count > max_reported_jobs)
3264 total_count = max_reported_jobs;
3267 *pcount = total_count;
3273 SAFE_FREE(data.dptr);
3274 SAFE_FREE(cgdata.dptr);
3275 talloc_free(tmp_ctx);
3279 /****************************************************************************
3280 Get a printer queue listing.
3281 set queue = NULL and status = NULL if you just want to update the cache
3282 ****************************************************************************/
3284 int print_queue_status(struct messaging_context *msg_ctx, int snum,
3285 print_queue_struct **ppqueue,
3286 print_status_struct *status)
3290 const char *sharename;
3291 struct tdb_print_db *pdb;
3294 /* make sure the database is up to date */
3296 if (print_cache_expired(lp_const_servicename(snum), True))
3297 print_queue_update(msg_ctx, snum, False);
3299 /* return if we are done */
3300 if ( !ppqueue || !status )
3304 sharename = lp_const_servicename(snum);
3305 pdb = get_print_db_byname(sharename);
3311 * Fetch the queue status. We must do this first, as there may
3312 * be no jobs in the queue.
3315 ZERO_STRUCTP(status);
3316 slprintf(keystr, sizeof(keystr)-1, "STATUS/%s", sharename);
3317 key = string_tdb_data(keystr);
3319 data = tdb_fetch(pdb->tdb, key);
3321 if (data.dsize == sizeof(*status)) {
3322 /* this memcpy is ok since the status struct was
3323 not packed before storing it in the tdb */
3324 memcpy(status, data.dptr, sizeof(*status));
3326 SAFE_FREE(data.dptr);
3330 * Now, fetch the print queue information. We first count the number
3331 * of entries, and then only retrieve the queue if necessary.
3334 if (!get_stored_queue_info(msg_ctx, pdb, snum, &count, ppqueue)) {
3335 release_print_db(pdb);
3339 release_print_db(pdb);
3343 /****************************************************************************
3345 ****************************************************************************/
3347 WERROR print_queue_pause(const struct auth_session_info *server_info,
3348 struct messaging_context *msg_ctx, int snum)
3351 struct printif *current_printif = get_printer_fns( snum );
3353 if (!W_ERROR_IS_OK(print_access_check(server_info, msg_ctx, snum,
3354 PRINTER_ACCESS_ADMINISTER))) {
3355 return WERR_ACCESS_DENIED;
3361 ret = (*(current_printif->queue_pause))(snum);
3366 return WERR_INVALID_PARAMETER;
3369 /* force update the database */
3370 print_cache_flush(lp_const_servicename(snum));
3372 /* Send a printer notify message */
3374 notify_printer_status(global_event_context(), msg_ctx, snum,
3375 PRINTER_STATUS_PAUSED);
3380 /****************************************************************************
3382 ****************************************************************************/
3384 WERROR print_queue_resume(const struct auth_session_info *server_info,
3385 struct messaging_context *msg_ctx, int snum)
3388 struct printif *current_printif = get_printer_fns( snum );
3390 if (!W_ERROR_IS_OK(print_access_check(server_info, msg_ctx, snum,
3391 PRINTER_ACCESS_ADMINISTER))) {
3392 return WERR_ACCESS_DENIED;
3397 ret = (*(current_printif->queue_resume))(snum);
3402 return WERR_INVALID_PARAMETER;
3405 /* make sure the database is up to date */
3406 if (print_cache_expired(lp_const_servicename(snum), True))
3407 print_queue_update(msg_ctx, snum, True);
3409 /* Send a printer notify message */
3411 notify_printer_status(global_event_context(), msg_ctx, snum,
3417 /****************************************************************************
3418 Purge a queue - implemented by deleting all jobs that we can delete.
3419 ****************************************************************************/
3421 WERROR print_queue_purge(const struct auth_session_info *server_info,
3422 struct messaging_context *msg_ctx, int snum)
3424 print_queue_struct *queue;
3425 print_status_struct status;
3429 /* Force and update so the count is accurate (i.e. not a cached count) */
3430 print_queue_update(msg_ctx, snum, True);
3432 can_job_admin = W_ERROR_IS_OK(print_access_check(server_info,
3435 JOB_ACCESS_ADMINISTER));
3436 njobs = print_queue_status(msg_ctx, snum, &queue, &status);
3438 if ( can_job_admin )
3441 for (i = 0; i < njobs; i++) {
3442 struct tdb_print_db *pdb;
3445 pdb = get_print_db_byname(lp_const_servicename(snum));
3447 DEBUG(1, ("failed to find printdb for %s\n",
3448 lp_const_servicename(snum)));
3451 jobid = sysjob_to_jobid_pdb(pdb, queue[i].sysjob);
3452 if (jobid == (uint32_t)-1) {
3453 DEBUG(2, ("jobid for system job %d not found\n",
3455 continue; /* unix job */
3457 owner = is_owner(server_info, lp_const_servicename(snum),
3460 if (owner || can_job_admin) {
3461 print_job_delete1(global_event_context(), msg_ctx,
3466 if ( can_job_admin )
3469 /* update the cache */
3470 print_queue_update(msg_ctx, snum, True);