source3/printing/notify.c

   1 /*
   2    Unix SMB/Netbios implementation.
   3    Version 3.0
   4    printing backend routines
   5    Copyright (C) Tim Potter, 2002
   6    Copyright (C) Gerald Carter,         2002
   7
   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.
  12
  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.
  17
  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/>.
  20 */
  21
  22 #include "includes.h"
  23 #include "printing.h"
  24 #include "librpc/gen_ndr/messaging.h"
  25 #include "../librpc/gen_ndr/spoolss.h"
  26 #include "nt_printing.h"
  27
  28 static TALLOC_CTX *send_ctx;
  29
  30 static unsigned int num_messages;
  31
  32 static struct notify_queue {
  33         struct notify_queue *next, *prev;
  34         struct spoolss_notify_msg *msg;
  35         struct timeval tv;
  36         uint8 *buf;
  37         size_t buflen;
  38 } *notify_queue_head = NULL;
  39
  40 static struct tevent_timer *notify_event;
  41
  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);
  44
  45 static bool create_send_ctx(void)
  46 {
  47         if (!send_ctx)
  48                 send_ctx = talloc_init("print notify queue");
  49
  50         if (!send_ctx)
  51                 return False;
  52
  53         return True;
  54 }
  55
  56 /****************************************************************************
  57  Turn a queue name into a snum.
  58 ****************************************************************************/
  59
  60 int print_queue_snum(const char *qname)
  61 {
  62         int snum = lp_servicenumber(qname);
  63         if (snum == -1 || !lp_print_ok(snum))
  64                 return -1;
  65         return snum;
  66 }
  67
  68 /*******************************************************************
  69  Used to decide if we need a short select timeout.
  70 *******************************************************************/
  71
  72 static bool print_notify_messages_pending(void)
  73 {
  74         return (notify_queue_head != NULL);
  75 }
  76
  77 /*******************************************************************
  78  Flatten data into a message.
  79 *******************************************************************/
  80
  81 static bool flatten_message(struct notify_queue *q)
  82 {
  83         struct spoolss_notify_msg *msg = q->msg;
  84         uint8 *buf = NULL;
  85         size_t buflen = 0, len;
  86
  87 again:
  88         len = 0;
  89
  90         /* Pack header */
  91
  92         len += tdb_pack(buf + len, buflen - len, "f", msg->printer);
  93
  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);
  97
  98         /* Pack data */
  99
 100         if (msg->len == 0)
 101                 len += tdb_pack(buf + len, buflen - len, "dd",
 102                                 msg->notify.value[0], msg->notify.value[1]);
 103         else
 104                 len += tdb_pack(buf + len, buflen - len, "B",
 105                                 msg->len, msg->notify.data);
 106
 107         if (buflen != len) {
 108                 buf = (uint8 *)TALLOC_REALLOC(send_ctx, buf, len);
 109                 if (!buf)
 110                         return False;
 111                 buflen = len;
 112                 goto again;
 113         }
 114
 115         q->buf = buf;
 116         q->buflen = buflen;
 117
 118         return True;
 119 }
 120
 121 /*******************************************************************
 122  Send the batched messages - on a per-printer basis.
 123 *******************************************************************/
 124
 125 static void print_notify_send_messages_to_printer(struct messaging_context *msg_ctx,
 126                                                   const char *printer,
 127                                                   unsigned int timeout)
 128 {
 129         char *buf;
 130         struct notify_queue *pq, *pq_next;
 131         size_t msg_count = 0, offset = 0;
 132         size_t num_pids = 0;
 133         size_t i;
 134         pid_t *pid_list = NULL;
 135         struct timeval end_time = timeval_zero();
 136
 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);
 143                                 num_messages = 0;
 144                                 return;
 145                         }
 146                         offset += (pq->buflen + 4);
 147                         msg_count++;
 148                 }
 149         }
 150         offset += 4; /* For count. */
 151
 152         buf = (char *)TALLOC(send_ctx, offset);
 153         if (!buf) {
 154                 DEBUG(0,("print_notify_send_messages: Out of memory\n"));
 155                 talloc_free_children(send_ctx);
 156                 num_messages = 0;
 157                 return;
 158         }
 159
 160         offset = 0;
 161         SIVAL(buf,offset,msg_count);
 162         offset += 4;
 163         for (pq = notify_queue_head; pq; pq = pq_next) {
 164                 pq_next = pq->next;
 165
 166                 if (strequal(printer, pq->msg->printer)) {
 167                         SIVAL(buf,offset,pq->buflen);
 168                         offset += 4;
 169                         memcpy(buf + offset, pq->buf, pq->buflen);
 170                         offset += pq->buflen;
 171
 172                         /* Remove from list. */
 173                         DLIST_REMOVE(notify_queue_head, pq);
 174                 }
 175         }
 176
 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));
 179
 180         /*
 181          * Get the list of PID's to send to.
 182          */
 183
 184         if (!print_notify_pid_list(printer, send_ctx, &num_pids, &pid_list))
 185                 return;
 186
 187         if (timeout != 0) {
 188                 end_time = timeval_current_ofs(timeout, 0);
 189         }
 190
 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);
 196
 197                 if ((timeout != 0) && timeval_expired(&end_time)) {
 198                         break;
 199                 }
 200         }
 201 }
 202
 203 /*******************************************************************
 204  Actually send the batched messages.
 205 *******************************************************************/
 206
 207 void print_notify_send_messages(struct messaging_context *msg_ctx,
 208                                 unsigned int timeout)
 209 {
 210         if (!print_notify_messages_pending())
 211                 return;
 212
 213         if (!create_send_ctx())
 214                 return;
 215
 216         while (print_notify_messages_pending())
 217                 print_notify_send_messages_to_printer(
 218                         msg_ctx, notify_queue_head->msg->printer, timeout);
 219
 220         talloc_free_children(send_ctx);
 221         num_messages = 0;
 222 }
 223
 224 /*******************************************************************
 225  Event handler to send the messages.
 226 *******************************************************************/
 227
 228 static void print_notify_event_send_messages(struct tevent_context *event_ctx,
 229                                              struct tevent_timer *te,
 230                                              struct timeval now,
 231                                              void *private_data)
 232 {
 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);
 237
 238         change_to_root_user();
 239         print_notify_send_messages(msg_ctx, 0);
 240 }
 241
 242 /**********************************************************************
 243  deep copy a SPOOLSS_NOTIFY_MSG structure using a TALLOC_CTX
 244  *********************************************************************/
 245
 246 static bool copy_notify2_msg( SPOOLSS_NOTIFY_MSG *to, SPOOLSS_NOTIFY_MSG *from )
 247 {
 248
 249         if ( !to || !from )
 250                 return False;
 251
 252         memcpy( to, from, sizeof(SPOOLSS_NOTIFY_MSG) );
 253
 254         if ( from->len ) {
 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 ));
 258                         return False;
 259                 }
 260         }
 261
 262
 263         return True;
 264 }
 265
 266 /*******************************************************************
 267  Batch up print notify messages.
 268 *******************************************************************/
 269
 270 static void send_spoolss_notify2_msg(struct tevent_context *ev,
 271                                      struct messaging_context *msg_ctx,
 272                                      SPOOLSS_NOTIFY_MSG *msg)
 273 {
 274         struct notify_queue *pnqueue, *tmp_ptr;
 275
 276         /*
 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.
 280          */
 281
 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 ))
 285         {
 286
 287                 for (tmp_ptr = notify_queue_head; tmp_ptr; tmp_ptr = tmp_ptr->next)
 288                 {
 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)) {
 294
 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));
 297
 298                                 tmp_ptr->msg = msg;
 299                                 return;
 300                         }
 301                 }
 302         }
 303
 304         /* Store the message on the pending queue. */
 305
 306         pnqueue = TALLOC_P(send_ctx, struct notify_queue);
 307         if (!pnqueue) {
 308                 DEBUG(0,("send_spoolss_notify2_msg: Out of memory.\n"));
 309                 return;
 310         }
 311
 312         /* allocate a new msg structure and copy the fields */
 313
 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)));
 317                 return;
 318         }
 319         copy_notify2_msg(pnqueue->msg, msg);
 320         GetTimeOfDay(&pnqueue->tv);
 321         pnqueue->buf = NULL;
 322         pnqueue->buflen = 0;
 323
 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));
 326
 327         /*
 328          * Note we add to the end of the list to ensure
 329          * the messages are sent in the order they were received. JRA.
 330          */
 331
 332         DLIST_ADD_END(notify_queue_head, pnqueue, struct notify_queue *);
 333         num_messages++;
 334
 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);
 340         }
 341
 342 }
 343
 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)
 349 {
 350         struct spoolss_notify_msg *msg;
 351
 352         if (lp_disable_spoolss())
 353                 return;
 354
 355         if (!create_send_ctx())
 356                 return;
 357
 358         msg = TALLOC_P(send_ctx, struct spoolss_notify_msg);
 359         if (!msg)
 360                 return;
 361
 362         ZERO_STRUCTP(msg);
 363
 364         fstrcpy(msg->printer, sharename);
 365         msg->type = type;
 366         msg->field = field;
 367         msg->id = id;
 368         msg->notify.value[0] = value1;
 369         msg->notify.value[1] = value2;
 370         msg->flags = flags;
 371
 372         send_spoolss_notify2_msg(ev, msg_ctx, msg);
 373 }
 374
 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,
 379                                      const char *buffer)
 380 {
 381         struct spoolss_notify_msg *msg;
 382
 383         if (lp_disable_spoolss())
 384                 return;
 385
 386         if (!create_send_ctx())
 387                 return;
 388
 389         msg = TALLOC_P(send_ctx, struct spoolss_notify_msg);
 390         if (!msg)
 391                 return;
 392
 393         ZERO_STRUCTP(msg);
 394
 395         fstrcpy(msg->printer, sharename);
 396         msg->type = type;
 397         msg->field = field;
 398         msg->id = id;
 399         msg->len = len;
 400         msg->notify.data = CONST_DISCARD(char *,buffer);
 401
 402         send_spoolss_notify2_msg(ev, msg_ctx, msg);
 403 }
 404
 405 /* Send a message that the printer status has changed */
 406
 407 void notify_printer_status_byname(struct tevent_context *ev,
 408                                   struct messaging_context *msg_ctx,
 409                                   const char *sharename, uint32 status)
 410 {
 411         /* Printer status stored in value1 */
 412
 413         int snum = print_queue_snum(sharename);
 414
 415         send_notify_field_values(ev, msg_ctx, sharename, PRINTER_NOTIFY_TYPE,
 416                                  PRINTER_NOTIFY_FIELD_STATUS, snum,
 417                                  status, 0, 0);
 418 }
 419
 420 void notify_printer_status(struct tevent_context *ev,
 421                            struct messaging_context *msg_ctx,
 422                            int snum, uint32 status)
 423 {
 424         const char *sharename = lp_servicename(snum);
 425
 426         if (sharename)
 427                 notify_printer_status_byname(ev, msg_ctx, sharename, status);
 428 }
 429
 430 void notify_job_status_byname(struct tevent_context *ev,
 431                               struct messaging_context *msg_ctx,
 432                               const char *sharename, uint32 jobid,
 433                               uint32 status,
 434                               uint32 flags)
 435 {
 436         /* Job id stored in id field, status in value1 */
 437
 438         send_notify_field_values(ev, msg_ctx,
 439                                  sharename, JOB_NOTIFY_TYPE,
 440                                  JOB_NOTIFY_FIELD_STATUS, jobid,
 441                                  status, 0, flags);
 442 }
 443
 444 void notify_job_status(const char *sharename, uint32 jobid, uint32 status)
 445 {
 446         notify_job_status_byname(server_event_context(),
 447                                  server_messaging_context(),
 448                                  sharename, jobid, status, 0);
 449 }
 450
 451 void notify_job_total_bytes(const char *sharename, uint32 jobid,
 452                             uint32 size)
 453 {
 454         /* Job id stored in id field, status in value1 */
 455
 456         send_notify_field_values(server_event_context(),
 457                                  server_messaging_context(),
 458                                  sharename, JOB_NOTIFY_TYPE,
 459                                  JOB_NOTIFY_FIELD_TOTAL_BYTES, jobid,
 460                                  size, 0, 0);
 461 }
 462
 463 void notify_job_total_pages(const char *sharename, uint32 jobid,
 464                             uint32 pages)
 465 {
 466         /* Job id stored in id field, status in value1 */
 467
 468         send_notify_field_values(server_event_context(),
 469                                  server_messaging_context(),
 470                                  sharename, JOB_NOTIFY_TYPE,
 471                                  JOB_NOTIFY_FIELD_TOTAL_PAGES, jobid,
 472                                  pages, 0, 0);
 473 }
 474
 475 void notify_job_username(const char *sharename, uint32 jobid, char *name)
 476 {
 477         send_notify_field_buffer(
 478                 server_event_context(), server_messaging_context(),
 479                 sharename, JOB_NOTIFY_TYPE, JOB_NOTIFY_FIELD_USER_NAME,
 480                 jobid, strlen(name) + 1, name);
 481 }
 482
 483 void notify_job_name(const char *sharename, uint32 jobid, char *name)
 484 {
 485         send_notify_field_buffer(
 486                 server_event_context(), server_messaging_context(),
 487                 sharename, JOB_NOTIFY_TYPE, JOB_NOTIFY_FIELD_DOCUMENT,
 488                 jobid, strlen(name) + 1, name);
 489 }
 490
 491 void notify_job_submitted(const char *sharename, uint32 jobid,
 492                           time_t submitted)
 493 {
 494         send_notify_field_buffer(
 495                 server_event_context(), server_messaging_context(),
 496                 sharename, JOB_NOTIFY_TYPE, JOB_NOTIFY_FIELD_SUBMITTED,
 497                 jobid, sizeof(submitted), (char *)&submitted);
 498 }
 499
 500 void notify_printer_driver(int snum, const char *driver_name)
 501 {
 502         const char *sharename = lp_servicename(snum);
 503
 504         send_notify_field_buffer(
 505                 server_event_context(), server_messaging_context(),
 506                 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_FIELD_DRIVER_NAME,
 507                 snum, strlen(driver_name) + 1, driver_name);
 508 }
 509
 510 void notify_printer_comment(int snum, const char *comment)
 511 {
 512         const char *sharename = lp_servicename(snum);
 513
 514         send_notify_field_buffer(
 515                 server_event_context(), server_messaging_context(),
 516                 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_FIELD_COMMENT,
 517                 snum, strlen(comment) + 1, comment);
 518 }
 519
 520 void notify_printer_sharename(int snum, const char *share_name)
 521 {
 522         const char *sharename = lp_servicename(snum);
 523
 524         send_notify_field_buffer(
 525                 server_event_context(), server_messaging_context(),
 526                 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_FIELD_SHARE_NAME,
 527                 snum, strlen(share_name) + 1, share_name);
 528 }
 529
 530 void notify_printer_printername(int snum, const char *printername)
 531 {
 532         const char *sharename = lp_servicename(snum);
 533
 534         send_notify_field_buffer(
 535                 server_event_context(), server_messaging_context(),
 536                 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_FIELD_PRINTER_NAME,
 537                 snum, strlen(printername) + 1, printername);
 538 }
 539
 540 void notify_printer_port(int snum, const char *port_name)
 541 {
 542         const char *sharename = lp_servicename(snum);
 543
 544         send_notify_field_buffer(
 545                 server_event_context(), server_messaging_context(),
 546                 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_FIELD_PORT_NAME,
 547                 snum, strlen(port_name) + 1, port_name);
 548 }
 549
 550 void notify_printer_location(int snum, const char *location)
 551 {
 552         const char *sharename = lp_servicename(snum);
 553
 554         send_notify_field_buffer(
 555                 server_event_context(), server_messaging_context(),
 556                 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_FIELD_LOCATION,
 557                 snum, strlen(location) + 1, location);
 558 }
 559
 560 void notify_printer_byname( const char *printername, uint32 change, const char *value )
 561 {
 562         int snum = print_queue_snum(printername);
 563         int type = PRINTER_NOTIFY_TYPE;
 564
 565         if ( snum == -1 )
 566                 return;
 567
 568         send_notify_field_buffer(
 569                 server_event_context(), server_messaging_context(),
 570                 printername, type, change, snum, strlen(value)+1, value );
 571 }
 572
 573
 574 /****************************************************************************
 575  Return a malloced list of pid_t's that are interested in getting update
 576  messages on this print queue. Used in printing/notify to send the messages.
 577 ****************************************************************************/
 578
 579 static bool print_notify_pid_list(const char *printername, TALLOC_CTX *mem_ctx,
 580                                   size_t *p_num_pids, pid_t **pp_pid_list)
 581 {
 582         struct tdb_print_db *pdb = NULL;
 583         TDB_CONTEXT *tdb = NULL;
 584         TDB_DATA data;
 585         bool ret = True;
 586         size_t i, num_pids, offset;
 587         pid_t *pid_list;
 588
 589         *p_num_pids = 0;
 590         *pp_pid_list = NULL;
 591
 592         pdb = get_print_db_byname(printername);
 593         if (!pdb)
 594                 return False;
 595         tdb = pdb->tdb;
 596
 597         if (tdb_read_lock_bystring_with_timeout(tdb, NOTIFY_PID_LIST_KEY, 10) == -1) {
 598                 DEBUG(0,("print_notify_pid_list: Failed to lock printer %s database\n",
 599                                         printername));
 600                 if (pdb)
 601                         release_print_db(pdb);
 602                 return False;
 603         }
 604
 605         data = get_printer_notify_pid_list( tdb, printername, True );
 606
 607         if (!data.dptr) {
 608                 ret = True;
 609                 goto done;
 610         }
 611
 612         num_pids = data.dsize / 8;
 613
 614         if (num_pids) {
 615                 if ((pid_list = TALLOC_ARRAY(mem_ctx, pid_t, num_pids)) == NULL) {
 616                         ret = False;
 617                         goto done;
 618                 }
 619         } else {
 620                 pid_list = NULL;
 621         }
 622
 623         for( i = 0, offset = 0; i < num_pids; offset += 8, i++)
 624                 pid_list[i] = (pid_t)IVAL(data.dptr, offset);
 625
 626         *pp_pid_list = pid_list;
 627         *p_num_pids = num_pids;
 628
 629         ret = True;
 630
 631   done:
 632
 633         tdb_read_unlock_bystring(tdb, NOTIFY_PID_LIST_KEY);
 634         if (pdb)
 635                 release_print_db(pdb);
 636         SAFE_FREE(data.dptr);
 637         return ret;
 638 }