printing/notify.c

ソースコードを見る。

データ構造
struct	notify_queue
関数
static BOOL	create_send_ctx (void)
int	print_queue_snum (const char *qname)
BOOL	print_notify_messages_pending (void)
static BOOL	flatten_message (struct notify_queue *q)
static void	print_notify_send_messages_to_printer (const char *printer, unsigned int timeout)
void	print_notify_send_messages (unsigned int timeout)
static BOOL	copy_notify2_msg (SPOOLSS_NOTIFY_MSG *to, SPOOLSS_NOTIFY_MSG *from)
static void	send_spoolss_notify2_msg (SPOOLSS_NOTIFY_MSG *msg)
static void	send_notify_field_values (const char *sharename, uint32 type, uint32 field, uint32 id, uint32 value1, uint32 value2, uint32 flags)
static void	send_notify_field_buffer (const char *sharename, uint32 type, uint32 field, uint32 id, uint32 len, const char *buffer)
void	notify_printer_status_byname (const char *sharename, uint32 status)
void	notify_printer_status (int snum, uint32 status)
void	notify_job_status_byname (const char *sharename, uint32 jobid, uint32 status, uint32 flags)
void	notify_job_status (const char *sharename, uint32 jobid, uint32 status)
void	notify_job_total_bytes (const char *sharename, uint32 jobid, uint32 size)
void	notify_job_total_pages (const char *sharename, uint32 jobid, uint32 pages)
void	notify_job_username (const char *sharename, uint32 jobid, char *name)
void	notify_job_name (const char *sharename, uint32 jobid, char *name)
void	notify_job_submitted (const char *sharename, uint32 jobid, time_t submitted)
void	notify_printer_driver (int snum, char *driver_name)
void	notify_printer_comment (int snum, char *comment)
void	notify_printer_sharename (int snum, char *share_name)
void	notify_printer_printername (int snum, char *printername)
void	notify_printer_port (int snum, char *port_name)
void	notify_printer_location (int snum, char *location)
void	notify_printer_byname (const char *printername, uint32 change, const char *value)
BOOL	print_notify_pid_list (const char *printername, TALLOC_CTX *mem_ctx, size_t *p_num_pids, pid_t **pp_pid_list)
変数
static TALLOC_CTX *	send_ctx
static unsigned int	num_messages
static struct notify_queue *	notify_queue_head

---

関数

static BOOL create_send_ctx

(

void

)

[static]

notify.c の 39 行で定義されています。

参照先 send_ctx・talloc_init().

参照元 print_notify_send_messages()・send_notify_field_buffer()・send_notify_field_values().

{
        if (!send_ctx)
                send_ctx = talloc_init("print notify queue");

        if (!send_ctx)
                return False;

        return True;
}

int print_queue_snum

(

const char *

qname

)

notify.c の 54 行で定義されています。

参照元 api_WPrintQueueCtrl()・free_printer_entry()・get_printer_snum()・notify_printer_byname()・spoolss_addprinterex_level_2()・update_monitored_printq_cache().

{
        int snum = lp_servicenumber(qname);
        if (snum == -1 || !lp_print_ok(snum))
                return -1;
        return snum;
}

BOOL print_notify_messages_pending

(

void

)

notify.c の 66 行で定義されています。

参照先 notify_queue_head.

参照元 print_notify_send_messages()・setup_select_timeout().

{
        return (notify_queue_head != NULL);
}

static BOOL flatten_message

(

struct notify_queue *

q

)

[static]

notify.c の 75 行で定義されています。

参照先 notify_queue::buf・buf・notify_queue::buflen・spoolss_notify_msg::data・spoolss_notify_msg::field・spoolss_notify_msg::flags・spoolss_notify_msg::id・spoolss_notify_msg::len・len・notify_queue::msg・spoolss_notify_msg::notify・spoolss_notify_msg::printer・send_ctx・tdb_pack()・notify_queue::tv・spoolss_notify_msg::type・spoolss_notify_msg::value.

参照元 print_notify_send_messages_to_printer().

{
        struct spoolss_notify_msg *msg = q->msg;
        char *buf = NULL;
        size_t buflen = 0, len;

again:
        len = 0;

        /* Pack header */

        len += tdb_pack(buf + len, buflen - len, "f", msg->printer);

        len += tdb_pack(buf + len, buflen - len, "ddddddd",
                        (uint32)q->tv.tv_sec, (uint32)q->tv.tv_usec,
                        msg->type, msg->field, msg->id, msg->len, msg->flags);

        /* Pack data */

        if (msg->len == 0)
                len += tdb_pack(buf + len, buflen - len, "dd",
                                msg->notify.value[0], msg->notify.value[1]);
        else
                len += tdb_pack(buf + len, buflen - len, "B",
                                msg->len, msg->notify.data);

        if (buflen != len) {
                buf = (char *)TALLOC_REALLOC(send_ctx, buf, len);
                if (!buf)
                        return False;
                buflen = len;
                goto again;
        }

        q->buf = buf;
        q->buflen = buflen;

        return True;
}

static void print_notify_send_messages_to_printer	(	const char *	printer,
		unsigned int	timeout
	)			[static]

notify.c の 119 行で定義されています。

参照先 buf・notify_queue::buflen・flatten_message()・notify_queue::msg・notify_queue::next・notify_queue_head・num_messages・spoolss_notify_msg::printer・send_ctx・strequal()・talloc_free_children().

参照元 print_notify_send_messages().

{
        char *buf;
        struct notify_queue *pq, *pq_next;
        size_t msg_count = 0, offset = 0;
        size_t num_pids = 0;
        size_t i;
        pid_t *pid_list = NULL;

        /* Count the space needed to send the messages. */
        for (pq = notify_queue_head; pq; pq = pq->next) {
                if (strequal(printer, pq->msg->printer)) {
                        if (!flatten_message(pq)) {
                                DEBUG(0,("print_notify_send_messages: Out of memory\n"));
                                talloc_free_children(send_ctx);
                                num_messages = 0;
                                return;
                        }
                        offset += (pq->buflen + 4);
                        msg_count++;
                }       
        }
        offset += 4; /* For count. */

        buf = (char *)TALLOC(send_ctx, offset);
        if (!buf) {
                DEBUG(0,("print_notify_send_messages: Out of memory\n"));
                talloc_free_children(send_ctx);
                num_messages = 0;
                return;
        }

        offset = 0;
        SIVAL(buf,offset,msg_count);
        offset += 4;
        for (pq = notify_queue_head; pq; pq = pq_next) {
                pq_next = pq->next;

                if (strequal(printer, pq->msg->printer)) {
                        SIVAL(buf,offset,pq->buflen);
                        offset += 4;
                        memcpy(buf + offset, pq->buf, pq->buflen);
                        offset += pq->buflen;

                        /* Remove from list. */
                        DLIST_REMOVE(notify_queue_head, pq);
                }
        }

        DEBUG(5, ("print_notify_send_messages_to_printer: sending %lu print notify message%s to printer %s\n", 
                  (unsigned long)msg_count, msg_count != 1 ? "s" : "", printer));

        /*
         * Get the list of PID's to send to.
         */

        if (!print_notify_pid_list(printer, send_ctx, &num_pids, &pid_list))
                return;

        for (i = 0; i < num_pids; i++) {
                unsigned int q_len = messages_pending_for_pid(pid_to_procid(pid_list[i]));
                if (q_len > 1000) {
                        DEBUG(5, ("print_notify_send_messages_to_printer: discarding notify to printer %s as queue length = %u\n",
                                printer, q_len ));
                        continue;
                }
                message_send_pid_with_timeout(pid_to_procid(pid_list[i]),
                                              MSG_PRINTER_NOTIFY2,
                                              buf, offset, True, timeout);
        }
}

void print_notify_send_messages

(

unsigned int

timeout

)

notify.c の 195 行で定義されています。

参照先 create_send_ctx()・notify_queue::msg・notify_queue_head・num_messages・print_notify_messages_pending()・print_notify_send_messages_to_printer()・spoolss_notify_msg::printer・send_ctx・talloc_free_children().

参照元 do_printnotify()・exit_server_common()・start_background_queue()・timeout_processing().

{
        if (!print_notify_messages_pending())
                return;

        if (!create_send_ctx())
                return;

        while (print_notify_messages_pending())
                print_notify_send_messages_to_printer(notify_queue_head->msg->printer, timeout);

        talloc_free_children(send_ctx);
        num_messages = 0;
}

static BOOL copy_notify2_msg	(	SPOOLSS_NOTIFY_MSG *	to,
		SPOOLSS_NOTIFY_MSG *	from
	)			[static]

notify.c の 214 行で定義されています。

参照先 from・send_ctx・to.

{

        if ( !to || !from )
                return False;
        
        memcpy( to, from, sizeof(SPOOLSS_NOTIFY_MSG) );
        
        if ( from->len ) {
                to->notify.data = (char *)TALLOC_MEMDUP(send_ctx, from->notify.data, from->len );
                if ( !to->notify.data ) {
                        DEBUG(0,("copy_notify2_msg: TALLOC_MEMDUP() of size [%d] failed!\n", from->len ));
                        return False;
                }
        }
        

        return True;
}

static void send_spoolss_notify2_msg

(

SPOOLSS_NOTIFY_MSG *

msg

)

[static]

notify.c の 238 行で定義されています。

参照先 spoolss_notify_msg::field・spoolss_notify_msg::flags・spoolss_notify_msg::id・notify_queue::msg・notify_queue::next・notify_queue_head・num_messages・spoolss_notify_msg::printer・strequal()・spoolss_notify_msg::type.

参照元 send_notify_field_buffer()・send_notify_field_values().

{
        struct notify_queue *pnqueue, *tmp_ptr;

        /*
         * Ensure we only have one job total_bytes and job total_pages for
         * each job. There is no point in sending multiple messages that match
         * as they will just cause flickering updates in the client.
         */

        if ((num_messages < 100) && (msg->type == JOB_NOTIFY_TYPE) 
                && (msg->field == JOB_NOTIFY_TOTAL_BYTES 
                    || msg->field == JOB_NOTIFY_TOTAL_PAGES )) 
        {

                for (tmp_ptr = notify_queue_head; tmp_ptr; tmp_ptr = tmp_ptr->next) 
                {
                        if (tmp_ptr->msg->type == msg->type &&
                                        tmp_ptr->msg->field == msg->field &&
                                        tmp_ptr->msg->id == msg->id &&
                                        tmp_ptr->msg->flags == msg->flags &&
                                        strequal(tmp_ptr->msg->printer, msg->printer)) {

                                DEBUG(5,("send_spoolss_notify2_msg: replacing message 0x%02x/0x%02x for "
                                         "printer %s in notify_queue\n", msg->type, msg->field, msg->printer));

                                tmp_ptr->msg = msg;
                                return;
                        }
                }
        }

        /* Store the message on the pending queue. */

        pnqueue = TALLOC_P(send_ctx, struct notify_queue);
        if (!pnqueue) {
                DEBUG(0,("send_spoolss_notify2_msg: Out of memory.\n"));
                return;
        }

        /* allocate a new msg structure and copy the fields */
        
        if ( !(pnqueue->msg = TALLOC_P(send_ctx, SPOOLSS_NOTIFY_MSG)) ) {
                DEBUG(0,("send_spoolss_notify2_msg: talloc() of size [%lu] failed!\n", 
                        (unsigned long)sizeof(SPOOLSS_NOTIFY_MSG)));
                return;
        }
        copy_notify2_msg(pnqueue->msg, msg);
        GetTimeOfDay(&pnqueue->tv);
        pnqueue->buf = NULL;
        pnqueue->buflen = 0;

        DEBUG(5, ("send_spoolss_notify2_msg: appending message 0x%02x/0x%02x for printer %s \
to notify_queue_head\n", msg->type, msg->field, msg->printer));

        /*
         * Note we add to the end of the list to ensure
         * the messages are sent in the order they were received. JRA.
         */

        DLIST_ADD_END(notify_queue_head, pnqueue, struct notify_queue *);
        num_messages++;
}

static void send_notify_field_values	(	const char *	sharename,
		uint32	type,
		uint32	field,
		uint32	id,
		uint32	value1,
		uint32	value2,
		uint32	flags
	)			[static]

notify.c の 302 行で定義されています。

参照先 create_send_ctx()・spoolss_notify_msg::field・spoolss_notify_msg::flags・spoolss_notify_msg::id・spoolss_notify_msg::notify・spoolss_notify_msg::printer・send_ctx・send_spoolss_notify2_msg()・spoolss_notify_msg::type・spoolss_notify_msg::value.

参照元 notify_job_status_byname()・notify_job_total_bytes()・notify_job_total_pages()・notify_printer_status_byname().

{
        struct spoolss_notify_msg *msg;

        if (lp_disable_spoolss())
                return;

        if (!create_send_ctx())
                return;

        msg = TALLOC_P(send_ctx, struct spoolss_notify_msg);
        if (!msg)
                return;

        ZERO_STRUCTP(msg);

        fstrcpy(msg->printer, sharename);
        msg->type = type;
        msg->field = field;
        msg->id = id;
        msg->notify.value[0] = value1;
        msg->notify.value[1] = value2;
        msg->flags = flags;

        send_spoolss_notify2_msg(msg);
}

static void send_notify_field_buffer	(	const char *	sharename,
		uint32	type,
		uint32	field,
		uint32	id,
		uint32	len,
		const char *	buffer
	)			[static]

notify.c の 331 行で定義されています。

参照先 create_send_ctx()・spoolss_notify_msg::data・spoolss_notify_msg::field・spoolss_notify_msg::id・spoolss_notify_msg::len・spoolss_notify_msg::notify・spoolss_notify_msg::printer・send_ctx・send_spoolss_notify2_msg()・spoolss_notify_msg::type.

参照元 notify_job_name()・notify_job_submitted()・notify_job_username()・notify_printer_byname()・notify_printer_comment()・notify_printer_driver()・notify_printer_location()・notify_printer_port()・notify_printer_printername()・notify_printer_sharename().

{
        struct spoolss_notify_msg *msg;

        if (lp_disable_spoolss())
                return;

        if (!create_send_ctx())
                return;

        msg = TALLOC_P(send_ctx, struct spoolss_notify_msg);
        if (!msg)
                return;

        ZERO_STRUCTP(msg);

        fstrcpy(msg->printer, sharename);
        msg->type = type;
        msg->field = field;
        msg->id = id;
        msg->len = len;
        msg->notify.data = CONST_DISCARD(char *,buffer);

        send_spoolss_notify2_msg(msg);
}

void notify_printer_status_byname	(	const char *	sharename,
		uint32	status
	)

notify.c の 361 行で定義されています。

参照先 send_notify_field_values().

参照元 do_printnotify()・notify_printer_status().

{
        /* Printer status stored in value1 */

        send_notify_field_values(sharename, PRINTER_NOTIFY_TYPE, 
                                 PRINTER_NOTIFY_STATUS, 0, 
                                 status, 0, 0);
}

void notify_printer_status	(	int	snum,
		uint32	status
	)

notify.c の 370 行で定義されています。

参照先 notify_printer_status_byname().

参照元 print_queue_pause()・print_queue_resume().

{
        const char *sharename = SERVICE(snum); 

        if (sharename)
                notify_printer_status_byname(sharename, status);
}

void notify_job_status_byname	(	const char *	sharename,
		uint32	jobid,
		uint32	status,
		uint32	flags
	)

notify.c の 378 行で定義されています。

参照先 send_notify_field_values().

参照元 do_printnotify()・notify_job_status().

{
        /* Job id stored in id field, status in value1 */

        send_notify_field_values(sharename, JOB_NOTIFY_TYPE,
                                 JOB_NOTIFY_STATUS, jobid,
                                 status, 0, flags);
}

void notify_job_status	(	const char *	sharename,
		uint32	jobid,
		uint32	status
	)

notify.c の 388 行で定義されています。

参照先 notify_job_status_byname().

参照元 pjob_delete()・pjob_store_notify()・print_job_pause()・print_job_resume().

{
        notify_job_status_byname(sharename, jobid, status, 0);
}

void notify_job_total_bytes	(	const char *	sharename,
		uint32	jobid,
		uint32	size
	)

notify.c の 393 行で定義されています。

参照先 send_notify_field_values().

参照元 pjob_store_notify().

{
        /* Job id stored in id field, status in value1 */

        send_notify_field_values(sharename, JOB_NOTIFY_TYPE,
                                 JOB_NOTIFY_TOTAL_BYTES, jobid,
                                 size, 0, 0);
}

void notify_job_total_pages	(	const char *	sharename,
		uint32	jobid,
		uint32	pages
	)

notify.c の 403 行で定義されています。

参照先 send_notify_field_values().

参照元 pjob_store_notify().

{
        /* Job id stored in id field, status in value1 */

        send_notify_field_values(sharename, JOB_NOTIFY_TYPE,
                                 JOB_NOTIFY_TOTAL_PAGES, jobid,
                                 pages, 0, 0);
}

void notify_job_username	(	const char *	sharename,
		uint32	jobid,
		char *	name
	)

notify.c の 413 行で定義されています。

参照先 send_notify_field_buffer().

参照元 pjob_store_notify().

{
        send_notify_field_buffer(
                sharename, JOB_NOTIFY_TYPE, JOB_NOTIFY_USER_NAME,
                jobid, strlen(name) + 1, name);
}

void notify_job_name	(	const char *	sharename,
		uint32	jobid,
		char *	name
	)

notify.c の 420 行で定義されています。

参照先 send_notify_field_buffer().

参照元 pjob_store_notify().

{
        send_notify_field_buffer(
                sharename, JOB_NOTIFY_TYPE, JOB_NOTIFY_DOCUMENT,
                jobid, strlen(name) + 1, name);
}

void notify_job_submitted	(	const char *	sharename,
		uint32	jobid,
		time_t	submitted
	)

notify.c の 427 行で定義されています。

参照先 send_notify_field_buffer().

参照元 pjob_store_notify().

{
        send_notify_field_buffer(
                sharename, JOB_NOTIFY_TYPE, JOB_NOTIFY_SUBMITTED,
                jobid, sizeof(submitted), (char *)&submitted);
}

void notify_printer_driver	(	int	snum,
		char *	driver_name
	)

notify.c の 435 行で定義されています。

参照先 send_notify_field_buffer().

参照元 update_printer().

{
        const char *sharename = SERVICE(snum);

        send_notify_field_buffer(
                sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_DRIVER_NAME,
                snum, strlen(driver_name) + 1, driver_name);
}

void notify_printer_comment	(	int	snum,
		char *	comment
	)

notify.c の 444 行で定義されています。

参照先 send_notify_field_buffer().

参照元 update_printer().

{
        const char *sharename = SERVICE(snum);

        send_notify_field_buffer(
                sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_COMMENT,
                snum, strlen(comment) + 1, comment);
}

void notify_printer_sharename	(	int	snum,
		char *	share_name
	)

notify.c の 453 行で定義されています。

参照先 send_notify_field_buffer().

参照元 update_printer().

{
        const char *sharename = SERVICE(snum);

        send_notify_field_buffer(
                sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_SHARE_NAME,
                snum, strlen(share_name) + 1, share_name);
}

void notify_printer_printername	(	int	snum,
		char *	printername
	)

notify.c の 462 行で定義されています。

参照先 send_notify_field_buffer().

参照元 update_printer().

{
        const char *sharename = SERVICE(snum);

        send_notify_field_buffer(
                sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_PRINTER_NAME,
                snum, strlen(printername) + 1, printername);
}

void notify_printer_port	(	int	snum,
		char *	port_name
	)

notify.c の 471 行で定義されています。

参照先 send_notify_field_buffer().

参照元 update_printer().

{
        const char *sharename = SERVICE(snum);

        send_notify_field_buffer(
                sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_PORT_NAME,
                snum, strlen(port_name) + 1, port_name);
}

void notify_printer_location	(	int	snum,
		char *	location
	)

notify.c の 480 行で定義されています。

参照先 send_notify_field_buffer().

参照元 update_printer().

{
        const char *sharename = SERVICE(snum);

        send_notify_field_buffer(
                sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_LOCATION,
                snum, strlen(location) + 1, location);
}

void notify_printer_byname	(	const char *	printername,
		uint32	change,
		const char *	value
	)

notify.c の 489 行で定義されています。

参照先 print_queue_snum()・send_notify_field_buffer()・type.

参照元 do_printnotify().

{
        int snum = print_queue_snum(printername);
        int type = PRINTER_NOTIFY_TYPE;
        
        if ( snum == -1 )
                return;
                
        send_notify_field_buffer( printername, type, change, snum, strlen(value)+1, value );
} 

BOOL print_notify_pid_list	(	const char *	printername,
		TALLOC_CTX *	mem_ctx,
		size_t *	p_num_pids,
		pid_t **	pp_pid_list
	)

notify.c の 506 行で定義されています。

参照先 TDB_DATA::dptr・TDB_DATA::dsize・get_print_db_byname()・get_printer_notify_pid_list()・release_print_db()・tdb_print_db::tdb・tdb・tdb_read_lock_bystring_with_timeout()・tdb_read_unlock_bystring().

{
        struct tdb_print_db *pdb = NULL;
        TDB_CONTEXT *tdb = NULL;
        TDB_DATA data;
        BOOL ret = True;
        size_t i, num_pids, offset;
        pid_t *pid_list;

        *p_num_pids = 0;
        *pp_pid_list = NULL;

        pdb = get_print_db_byname(printername);
        if (!pdb)
                return False;
        tdb = pdb->tdb;

        if (tdb_read_lock_bystring_with_timeout(tdb, NOTIFY_PID_LIST_KEY, 10) == -1) {
                DEBUG(0,("print_notify_pid_list: Failed to lock printer %s database\n",
                                        printername));
                if (pdb)
                        release_print_db(pdb);
                return False;
        }

        data = get_printer_notify_pid_list( tdb, printername, True );

        if (!data.dptr) {
                ret = True;
                goto done;
        }

        num_pids = data.dsize / 8;

        if (num_pids) {
                if ((pid_list = TALLOC_ARRAY(mem_ctx, pid_t, num_pids)) == NULL) {
                        ret = False;
                        goto done;
                }
        } else {
                pid_list = NULL;
        }

        for( i = 0, offset = 0; offset < data.dsize; offset += 8, i++)
                pid_list[i] = (pid_t)IVAL(data.dptr, offset);

        *pp_pid_list = pid_list;
        *p_num_pids = num_pids;

        ret = True;

  done:

        tdb_read_unlock_bystring(tdb, NOTIFY_PID_LIST_KEY);
        if (pdb)
                release_print_db(pdb);
        SAFE_FREE(data.dptr);
        return ret;
}

---

変数

TALLOC_CTX* send_ctx [static]

notify.c の 26 行で定義されています。

参照元 copy_notify2_msg()・create_send_ctx()・flatten_message()・print_notify_send_messages()・print_notify_send_messages_to_printer()・send_notify_field_buffer()・send_notify_field_values().

unsigned int num_messages [static]

notify.c の 28 行で定義されています。

参照元 print_notify_send_messages()・print_notify_send_messages_to_printer()・send_spoolss_notify2_msg().

struct notify_queue * notify_queue_head [static]

参照元 print_notify_messages_pending()・print_notify_send_messages()・print_notify_send_messages_to_printer()・send_spoolss_notify2_msg().

---