2 Unix SMB/Netbios implementation.
4 printing backend routines
5 Copyright (C) Tim Potter, 2002
6 Copyright (C) Gerald Carter, 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/>.
24 #include "librpc/gen_ndr/messaging.h"
25 #include "../librpc/gen_ndr/spoolss.h"
26 #include "nt_printing.h"
28 static TALLOC_CTX *send_ctx;
30 static unsigned int num_messages;
32 static struct notify_queue {
33 struct notify_queue *next, *prev;
34 struct spoolss_notify_msg *msg;
38 } *notify_queue_head = NULL;
40 static struct tevent_timer *notify_event;
42 static bool print_notify_pid_list(const char *printername, TALLOC_CTX *mem_ctx,
43 size_t *p_num_pids, pid_t **pp_pid_list);
45 static bool create_send_ctx(void)
48 send_ctx = talloc_init("print notify queue");
56 /****************************************************************************
57 Turn a queue name into a snum.
58 ****************************************************************************/
60 int print_queue_snum(const char *qname)
62 int snum = lp_servicenumber(qname);
63 if (snum == -1 || !lp_print_ok(snum))
68 /*******************************************************************
69 Used to decide if we need a short select timeout.
70 *******************************************************************/
72 static bool print_notify_messages_pending(void)
74 return (notify_queue_head != NULL);
77 /*******************************************************************
78 Flatten data into a message.
79 *******************************************************************/
81 static bool flatten_message(struct notify_queue *q)
83 struct spoolss_notify_msg *msg = q->msg;
85 size_t buflen = 0, len;
92 len += tdb_pack(buf + len, buflen - len, "f", msg->printer);
94 len += tdb_pack(buf + len, buflen - len, "ddddddd",
95 (uint32)q->tv.tv_sec, (uint32)q->tv.tv_usec,
96 msg->type, msg->field, msg->id, msg->len, msg->flags);
101 len += tdb_pack(buf + len, buflen - len, "dd",
102 msg->notify.value[0], msg->notify.value[1]);
104 len += tdb_pack(buf + len, buflen - len, "B",
105 msg->len, msg->notify.data);
108 buf = (uint8 *)TALLOC_REALLOC(send_ctx, buf, len);
121 /*******************************************************************
122 Send the batched messages - on a per-printer basis.
123 *******************************************************************/
125 static void print_notify_send_messages_to_printer(struct messaging_context *msg_ctx,
127 unsigned int timeout)
130 struct notify_queue *pq, *pq_next;
131 size_t msg_count = 0, offset = 0;
134 pid_t *pid_list = NULL;
135 struct timeval end_time = timeval_zero();
137 /* Count the space needed to send the messages. */
138 for (pq = notify_queue_head; pq; pq = pq->next) {
139 if (strequal(printer, pq->msg->printer)) {
140 if (!flatten_message(pq)) {
141 DEBUG(0,("print_notify_send_messages: Out of memory\n"));
142 talloc_free_children(send_ctx);
146 offset += (pq->buflen + 4);
150 offset += 4; /* For count. */
152 buf = (char *)TALLOC(send_ctx, offset);
154 DEBUG(0,("print_notify_send_messages: Out of memory\n"));
155 talloc_free_children(send_ctx);
161 SIVAL(buf,offset,msg_count);
163 for (pq = notify_queue_head; pq; pq = pq_next) {
166 if (strequal(printer, pq->msg->printer)) {
167 SIVAL(buf,offset,pq->buflen);
169 memcpy(buf + offset, pq->buf, pq->buflen);
170 offset += pq->buflen;
172 /* Remove from list. */
173 DLIST_REMOVE(notify_queue_head, pq);
177 DEBUG(5, ("print_notify_send_messages_to_printer: sending %lu print notify message%s to printer %s\n",
178 (unsigned long)msg_count, msg_count != 1 ? "s" : "", printer));
181 * Get the list of PID's to send to.
184 if (!print_notify_pid_list(printer, send_ctx, &num_pids, &pid_list))
188 end_time = timeval_current_ofs(timeout, 0);
191 for (i = 0; i < num_pids; i++) {
192 messaging_send_buf(msg_ctx,
193 pid_to_procid(pid_list[i]),
194 MSG_PRINTER_NOTIFY2 | MSG_FLAG_LOWPRIORITY,
195 (uint8 *)buf, offset);
197 if ((timeout != 0) && timeval_expired(&end_time)) {
203 /*******************************************************************
204 Actually send the batched messages.
205 *******************************************************************/
207 void print_notify_send_messages(struct messaging_context *msg_ctx,
208 unsigned int timeout)
210 if (!print_notify_messages_pending())
213 if (!create_send_ctx())
216 while (print_notify_messages_pending())
217 print_notify_send_messages_to_printer(
218 msg_ctx, notify_queue_head->msg->printer, timeout);
220 talloc_free_children(send_ctx);
224 /*******************************************************************
225 Event handler to send the messages.
226 *******************************************************************/
228 static void print_notify_event_send_messages(struct tevent_context *event_ctx,
229 struct tevent_timer *te,
233 struct messaging_context *msg_ctx = talloc_get_type_abort(
234 private_data, struct messaging_context);
235 /* Remove this timed event handler. */
236 TALLOC_FREE(notify_event);
238 change_to_root_user();
239 print_notify_send_messages(msg_ctx, 0);
242 /**********************************************************************
243 deep copy a SPOOLSS_NOTIFY_MSG structure using a TALLOC_CTX
244 *********************************************************************/
246 static bool copy_notify2_msg( SPOOLSS_NOTIFY_MSG *to, SPOOLSS_NOTIFY_MSG *from )
252 memcpy( to, from, sizeof(SPOOLSS_NOTIFY_MSG) );
255 to->notify.data = (char *)TALLOC_MEMDUP(send_ctx, from->notify.data, from->len );
256 if ( !to->notify.data ) {
257 DEBUG(0,("copy_notify2_msg: TALLOC_MEMDUP() of size [%d] failed!\n", from->len ));
266 /*******************************************************************
267 Batch up print notify messages.
268 *******************************************************************/
270 static void send_spoolss_notify2_msg(struct tevent_context *ev,
271 struct messaging_context *msg_ctx,
272 SPOOLSS_NOTIFY_MSG *msg)
274 struct notify_queue *pnqueue, *tmp_ptr;
277 * Ensure we only have one job total_bytes and job total_pages for
278 * each job. There is no point in sending multiple messages that match
279 * as they will just cause flickering updates in the client.
282 if ((num_messages < 100) && (msg->type == JOB_NOTIFY_TYPE)
283 && (msg->field == JOB_NOTIFY_FIELD_TOTAL_BYTES
284 || msg->field == JOB_NOTIFY_FIELD_TOTAL_PAGES ))
287 for (tmp_ptr = notify_queue_head; tmp_ptr; tmp_ptr = tmp_ptr->next)
289 if (tmp_ptr->msg->type == msg->type &&
290 tmp_ptr->msg->field == msg->field &&
291 tmp_ptr->msg->id == msg->id &&
292 tmp_ptr->msg->flags == msg->flags &&
293 strequal(tmp_ptr->msg->printer, msg->printer)) {
295 DEBUG(5,("send_spoolss_notify2_msg: replacing message 0x%02x/0x%02x for "
296 "printer %s in notify_queue\n", msg->type, msg->field, msg->printer));
304 /* Store the message on the pending queue. */
306 pnqueue = TALLOC_P(send_ctx, struct notify_queue);
308 DEBUG(0,("send_spoolss_notify2_msg: Out of memory.\n"));
312 /* allocate a new msg structure and copy the fields */
314 if ( !(pnqueue->msg = TALLOC_P(send_ctx, SPOOLSS_NOTIFY_MSG)) ) {
315 DEBUG(0,("send_spoolss_notify2_msg: talloc() of size [%lu] failed!\n",
316 (unsigned long)sizeof(SPOOLSS_NOTIFY_MSG)));
319 copy_notify2_msg(pnqueue->msg, msg);
320 GetTimeOfDay(&pnqueue->tv);
324 DEBUG(5, ("send_spoolss_notify2_msg: appending message 0x%02x/0x%02x for printer %s \
325 to notify_queue_head\n", msg->type, msg->field, msg->printer));
328 * Note we add to the end of the list to ensure
329 * the messages are sent in the order they were received. JRA.
332 DLIST_ADD_END(notify_queue_head, pnqueue, struct notify_queue *);
335 if ((notify_event == NULL) && (ev != NULL)) {
336 /* Add an event for 1 second's time to send this queue. */
337 notify_event = tevent_add_timer(
338 ev, NULL, timeval_current_ofs(1,0),
339 print_notify_event_send_messages, msg_ctx);
344 static void send_notify_field_values(struct tevent_context *ev,
345 struct messaging_context *msg_ctx,
346 const char *sharename, uint32 type,
347 uint32 field, uint32 id, uint32 value1,
348 uint32 value2, uint32 flags)
350 struct spoolss_notify_msg *msg;
352 if (lp_disable_spoolss())
355 if (!create_send_ctx())
358 msg = TALLOC_P(send_ctx, struct spoolss_notify_msg);
364 fstrcpy(msg->printer, sharename);
368 msg->notify.value[0] = value1;
369 msg->notify.value[1] = value2;
372 send_spoolss_notify2_msg(ev, msg_ctx, msg);
375 static void send_notify_field_buffer(struct tevent_context *ev,
376 struct messaging_context *msg_ctx,
377 const char *sharename, uint32 type,
378 uint32 field, uint32 id, uint32 len,
381 struct spoolss_notify_msg *msg;
383 if (lp_disable_spoolss())
386 if (!create_send_ctx())
389 msg = TALLOC_P(send_ctx, struct spoolss_notify_msg);
395 fstrcpy(msg->printer, sharename);
400 msg->notify.data = CONST_DISCARD(char *,buffer);
402 send_spoolss_notify2_msg(ev, msg_ctx, msg);
405 /* Send a message that the printer status has changed */
407 void notify_printer_status_byname(struct tevent_context *ev,
408 struct messaging_context *msg_ctx,
409 const char *sharename, uint32 status)
411 /* Printer status stored in value1 */
413 int snum = print_queue_snum(sharename);
415 send_notify_field_values(ev, msg_ctx, sharename, PRINTER_NOTIFY_TYPE,
416 PRINTER_NOTIFY_FIELD_STATUS, snum,
420 void notify_printer_status(struct tevent_context *ev,
421 struct messaging_context *msg_ctx,
422 int snum, uint32 status)
424 const char *sharename = lp_servicename(snum);
427 notify_printer_status_byname(ev, msg_ctx, sharename, status);
430 void notify_job_status_byname(struct tevent_context *ev,
431 struct messaging_context *msg_ctx,
432 const char *sharename, uint32 jobid,
436 /* Job id stored in id field, status in value1 */
438 send_notify_field_values(ev, msg_ctx,
439 sharename, JOB_NOTIFY_TYPE,
440 JOB_NOTIFY_FIELD_STATUS, jobid,
444 void notify_job_status(struct tevent_context *ev,
445 struct messaging_context *msg_ctx,
446 const char *sharename, uint32 jobid, uint32 status)
448 notify_job_status_byname(ev, msg_ctx, sharename, jobid, status, 0);
451 void notify_job_total_bytes(struct tevent_context *ev,
452 struct messaging_context *msg_ctx,
453 const char *sharename, uint32 jobid,
456 /* Job id stored in id field, status in value1 */
458 send_notify_field_values(ev, msg_ctx,
459 sharename, JOB_NOTIFY_TYPE,
460 JOB_NOTIFY_FIELD_TOTAL_BYTES, jobid,
464 void notify_job_total_pages(struct tevent_context *ev,
465 struct messaging_context *msg_ctx,
466 const char *sharename, uint32 jobid,
469 /* Job id stored in id field, status in value1 */
471 send_notify_field_values(ev, msg_ctx,
472 sharename, JOB_NOTIFY_TYPE,
473 JOB_NOTIFY_FIELD_TOTAL_PAGES, jobid,
477 void notify_job_username(struct tevent_context *ev,
478 struct messaging_context *msg_ctx,
479 const char *sharename, uint32 jobid, char *name)
481 send_notify_field_buffer(
483 sharename, JOB_NOTIFY_TYPE, JOB_NOTIFY_FIELD_USER_NAME,
484 jobid, strlen(name) + 1, name);
487 void notify_job_name(struct tevent_context *ev,
488 struct messaging_context *msg_ctx,
489 const char *sharename, uint32 jobid, char *name)
491 send_notify_field_buffer(
493 sharename, JOB_NOTIFY_TYPE, JOB_NOTIFY_FIELD_DOCUMENT,
494 jobid, strlen(name) + 1, name);
497 void notify_job_submitted(struct tevent_context *ev,
498 struct messaging_context *msg_ctx,
499 const char *sharename, uint32 jobid,
502 send_notify_field_buffer(
504 sharename, JOB_NOTIFY_TYPE, JOB_NOTIFY_FIELD_SUBMITTED,
505 jobid, sizeof(submitted), (char *)&submitted);
508 void notify_printer_driver(struct tevent_context *ev,
509 struct messaging_context *msg_ctx,
510 int snum, const char *driver_name)
512 const char *sharename = lp_servicename(snum);
514 send_notify_field_buffer(
516 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_FIELD_DRIVER_NAME,
517 snum, strlen(driver_name) + 1, driver_name);
520 void notify_printer_comment(struct tevent_context *ev,
521 struct messaging_context *msg_ctx,
522 int snum, const char *comment)
524 const char *sharename = lp_servicename(snum);
526 send_notify_field_buffer(
528 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_FIELD_COMMENT,
529 snum, strlen(comment) + 1, comment);
532 void notify_printer_sharename(struct tevent_context *ev,
533 struct messaging_context *msg_ctx,
534 int snum, const char *share_name)
536 const char *sharename = lp_servicename(snum);
538 send_notify_field_buffer(
540 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_FIELD_SHARE_NAME,
541 snum, strlen(share_name) + 1, share_name);
544 void notify_printer_printername(struct tevent_context *ev,
545 struct messaging_context *msg_ctx,
546 int snum, const char *printername)
548 const char *sharename = lp_servicename(snum);
550 send_notify_field_buffer(
552 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_FIELD_PRINTER_NAME,
553 snum, strlen(printername) + 1, printername);
556 void notify_printer_port(int snum, const char *port_name)
558 const char *sharename = lp_servicename(snum);
560 send_notify_field_buffer(
561 server_event_context(), server_messaging_context(),
562 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_FIELD_PORT_NAME,
563 snum, strlen(port_name) + 1, port_name);
566 void notify_printer_location(int snum, const char *location)
568 const char *sharename = lp_servicename(snum);
570 send_notify_field_buffer(
571 server_event_context(), server_messaging_context(),
572 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_FIELD_LOCATION,
573 snum, strlen(location) + 1, location);
576 void notify_printer_byname( const char *printername, uint32 change, const char *value )
578 int snum = print_queue_snum(printername);
579 int type = PRINTER_NOTIFY_TYPE;
584 send_notify_field_buffer(
585 server_event_context(), server_messaging_context(),
586 printername, type, change, snum, strlen(value)+1, value );
590 /****************************************************************************
591 Return a malloced list of pid_t's that are interested in getting update
592 messages on this print queue. Used in printing/notify to send the messages.
593 ****************************************************************************/
595 static bool print_notify_pid_list(const char *printername, TALLOC_CTX *mem_ctx,
596 size_t *p_num_pids, pid_t **pp_pid_list)
598 struct tdb_print_db *pdb = NULL;
599 TDB_CONTEXT *tdb = NULL;
602 size_t i, num_pids, offset;
608 pdb = get_print_db_byname(printername);
613 if (tdb_read_lock_bystring_with_timeout(tdb, NOTIFY_PID_LIST_KEY, 10) == -1) {
614 DEBUG(0,("print_notify_pid_list: Failed to lock printer %s database\n",
617 release_print_db(pdb);
621 data = get_printer_notify_pid_list( tdb, printername, True );
628 num_pids = data.dsize / 8;
631 if ((pid_list = TALLOC_ARRAY(mem_ctx, pid_t, num_pids)) == NULL) {
639 for( i = 0, offset = 0; i < num_pids; offset += 8, i++)
640 pid_list[i] = (pid_t)IVAL(data.dptr, offset);
642 *pp_pid_list = pid_list;
643 *p_num_pids = num_pids;
649 tdb_read_unlock_bystring(tdb, NOTIFY_PID_LIST_KEY);
651 release_print_db(pdb);
652 SAFE_FREE(data.dptr);