source/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
  25 static TALLOC_CTX *send_ctx;
  26
  27 static unsigned int num_messages;
  28
  29 static struct notify_queue {
  30         struct notify_queue *next, *prev;
  31         struct spoolss_notify_msg *msg;
  32         struct timeval tv;
  33         uint8 *buf;
  34         size_t buflen;
  35 } *notify_queue_head = NULL;
  36
  37 static struct timed_event *notify_event;
  38
  39 static bool create_send_ctx(void)
  40 {
  41         if (!send_ctx)
  42                 send_ctx = talloc_init("print notify queue");
  43
  44         if (!send_ctx)
  45                 return False;
  46
  47         return True;
  48 }
  49
  50 /****************************************************************************
  51  Turn a queue name into a snum.
  52 ****************************************************************************/
  53
  54 int print_queue_snum(const char *qname)
  55 {
  56         int snum = lp_servicenumber(qname);
  57         if (snum == -1 || !lp_print_ok(snum))
  58                 return -1;
  59         return snum;
  60 }
  61
  62 /*******************************************************************
  63  Used to decide if we need a short select timeout.
  64 *******************************************************************/
  65
  66 bool print_notify_messages_pending(void)
  67 {
  68         return (notify_queue_head != NULL);
  69 }
  70
  71 /*******************************************************************
  72  Flatten data into a message.
  73 *******************************************************************/
  74
  75 static bool flatten_message(struct notify_queue *q)
  76 {
  77         struct spoolss_notify_msg *msg = q->msg;
  78         uint8 *buf = NULL;
  79         size_t buflen = 0, len;
  80
  81 again:
  82         len = 0;
  83
  84         /* Pack header */
  85
  86         len += tdb_pack(buf + len, buflen - len, "f", msg->printer);
  87
  88         len += tdb_pack(buf + len, buflen - len, "ddddddd",
  89                         (uint32)q->tv.tv_sec, (uint32)q->tv.tv_usec,
  90                         msg->type, msg->field, msg->id, msg->len, msg->flags);
  91
  92         /* Pack data */
  93
  94         if (msg->len == 0)
  95                 len += tdb_pack(buf + len, buflen - len, "dd",
  96                                 msg->notify.value[0], msg->notify.value[1]);
  97         else
  98                 len += tdb_pack(buf + len, buflen - len, "B",
  99                                 msg->len, msg->notify.data);
 100
 101         if (buflen != len) {
 102                 buf = (uint8 *)TALLOC_REALLOC(send_ctx, buf, len);
 103                 if (!buf)
 104                         return False;
 105                 buflen = len;
 106                 goto again;
 107         }
 108
 109         q->buf = buf;
 110         q->buflen = buflen;
 111
 112         return True;
 113 }
 114
 115 /*******************************************************************
 116  Send the batched messages - on a per-printer basis.
 117 *******************************************************************/
 118
 119 static void print_notify_send_messages_to_printer(struct messaging_context *msg_ctx,
 120                                                   const char *printer,
 121                                                   unsigned int timeout)
 122 {
 123         char *buf;
 124         struct notify_queue *pq, *pq_next;
 125         size_t msg_count = 0, offset = 0;
 126         size_t num_pids = 0;
 127         size_t i;
 128         pid_t *pid_list = NULL;
 129         struct timeval end_time = timeval_zero();
 130
 131         /* Count the space needed to send the messages. */
 132         for (pq = notify_queue_head; pq; pq = pq->next) {
 133                 if (strequal(printer, pq->msg->printer)) {
 134                         if (!flatten_message(pq)) {
 135                                 DEBUG(0,("print_notify_send_messages: Out of memory\n"));
 136                                 talloc_free_children(send_ctx);
 137                                 num_messages = 0;
 138                                 return;
 139                         }
 140                         offset += (pq->buflen + 4);
 141                         msg_count++;
 142                 }
 143         }
 144         offset += 4; /* For count. */
 145
 146         buf = (char *)TALLOC(send_ctx, offset);
 147         if (!buf) {
 148                 DEBUG(0,("print_notify_send_messages: Out of memory\n"));
 149                 talloc_free_children(send_ctx);
 150                 num_messages = 0;
 151                 return;
 152         }
 153
 154         offset = 0;
 155         SIVAL(buf,offset,msg_count);
 156         offset += 4;
 157         for (pq = notify_queue_head; pq; pq = pq_next) {
 158                 pq_next = pq->next;
 159
 160                 if (strequal(printer, pq->msg->printer)) {
 161                         SIVAL(buf,offset,pq->buflen);
 162                         offset += 4;
 163                         memcpy(buf + offset, pq->buf, pq->buflen);
 164                         offset += pq->buflen;
 165
 166                         /* Remove from list. */
 167                         DLIST_REMOVE(notify_queue_head, pq);
 168                 }
 169         }
 170
 171         DEBUG(5, ("print_notify_send_messages_to_printer: sending %lu print notify message%s to printer %s\n",
 172                   (unsigned long)msg_count, msg_count != 1 ? "s" : "", printer));
 173
 174         /*
 175          * Get the list of PID's to send to.
 176          */
 177
 178         if (!print_notify_pid_list(printer, send_ctx, &num_pids, &pid_list))
 179                 return;
 180
 181         if (timeout != 0) {
 182                 end_time = timeval_current_ofs(timeout, 0);
 183         }
 184
 185         for (i = 0; i < num_pids; i++) {
 186                 messaging_send_buf(msg_ctx,
 187                                    pid_to_procid(pid_list[i]),
 188                                    MSG_PRINTER_NOTIFY2 | MSG_FLAG_LOWPRIORITY,
 189                                    (uint8 *)buf, offset);
 190
 191                 if ((timeout != 0) && timeval_expired(&end_time)) {
 192                         break;
 193                 }
 194         }
 195 }
 196
 197 /*******************************************************************
 198  Actually send the batched messages.
 199 *******************************************************************/
 200
 201 void print_notify_send_messages(struct messaging_context *msg_ctx,
 202                                 unsigned int timeout)
 203 {
 204         if (!print_notify_messages_pending())
 205                 return;
 206
 207         if (!create_send_ctx())
 208                 return;
 209
 210         while (print_notify_messages_pending())
 211                 print_notify_send_messages_to_printer(
 212                         msg_ctx, notify_queue_head->msg->printer, timeout);
 213
 214         talloc_free_children(send_ctx);
 215         num_messages = 0;
 216 }
 217
 218 /*******************************************************************
 219  Event handler to send the messages.
 220 *******************************************************************/
 221
 222 static void print_notify_event_send_messages(struct event_context *event_ctx,
 223                                         struct timed_event *te,
 224                                         const struct timeval *now,
 225                                         void *private_data)
 226 {
 227         /* Remove this timed event handler. */
 228         TALLOC_FREE(notify_event);
 229
 230         change_to_root_user();
 231         print_notify_send_messages(smbd_messaging_context(), 0);
 232 }
 233
 234 /**********************************************************************
 235  deep copy a SPOOLSS_NOTIFY_MSG structure using a TALLOC_CTX
 236  *********************************************************************/
 237
 238 static bool copy_notify2_msg( SPOOLSS_NOTIFY_MSG *to, SPOOLSS_NOTIFY_MSG *from )
 239 {
 240
 241         if ( !to || !from )
 242                 return False;
 243
 244         memcpy( to, from, sizeof(SPOOLSS_NOTIFY_MSG) );
 245
 246         if ( from->len ) {
 247                 to->notify.data = (char *)TALLOC_MEMDUP(send_ctx, from->notify.data, from->len );
 248                 if ( !to->notify.data ) {
 249                         DEBUG(0,("copy_notify2_msg: TALLOC_MEMDUP() of size [%d] failed!\n", from->len ));
 250                         return False;
 251                 }
 252         }
 253
 254
 255         return True;
 256 }
 257
 258 /*******************************************************************
 259  Batch up print notify messages.
 260 *******************************************************************/
 261
 262 static void send_spoolss_notify2_msg(SPOOLSS_NOTIFY_MSG *msg)
 263 {
 264         struct notify_queue *pnqueue, *tmp_ptr;
 265
 266         /*
 267          * Ensure we only have one job total_bytes and job total_pages for
 268          * each job. There is no point in sending multiple messages that match
 269          * as they will just cause flickering updates in the client.
 270          */
 271
 272         if ((num_messages < 100) && (msg->type == JOB_NOTIFY_TYPE)
 273                 && (msg->field == JOB_NOTIFY_TOTAL_BYTES
 274                     || msg->field == JOB_NOTIFY_TOTAL_PAGES ))
 275         {
 276
 277                 for (tmp_ptr = notify_queue_head; tmp_ptr; tmp_ptr = tmp_ptr->next)
 278                 {
 279                         if (tmp_ptr->msg->type == msg->type &&
 280                                         tmp_ptr->msg->field == msg->field &&
 281                                         tmp_ptr->msg->id == msg->id &&
 282                                         tmp_ptr->msg->flags == msg->flags &&
 283                                         strequal(tmp_ptr->msg->printer, msg->printer)) {
 284
 285                                 DEBUG(5,("send_spoolss_notify2_msg: replacing message 0x%02x/0x%02x for "
 286                                          "printer %s in notify_queue\n", msg->type, msg->field, msg->printer));
 287
 288                                 tmp_ptr->msg = msg;
 289                                 return;
 290                         }
 291                 }
 292         }
 293
 294         /* Store the message on the pending queue. */
 295
 296         pnqueue = TALLOC_P(send_ctx, struct notify_queue);
 297         if (!pnqueue) {
 298                 DEBUG(0,("send_spoolss_notify2_msg: Out of memory.\n"));
 299                 return;
 300         }
 301
 302         /* allocate a new msg structure and copy the fields */
 303
 304         if ( !(pnqueue->msg = TALLOC_P(send_ctx, SPOOLSS_NOTIFY_MSG)) ) {
 305                 DEBUG(0,("send_spoolss_notify2_msg: talloc() of size [%lu] failed!\n",
 306                         (unsigned long)sizeof(SPOOLSS_NOTIFY_MSG)));
 307                 return;
 308         }
 309         copy_notify2_msg(pnqueue->msg, msg);
 310         GetTimeOfDay(&pnqueue->tv);
 311         pnqueue->buf = NULL;
 312         pnqueue->buflen = 0;
 313
 314         DEBUG(5, ("send_spoolss_notify2_msg: appending message 0x%02x/0x%02x for printer %s \
 315 to notify_queue_head\n", msg->type, msg->field, msg->printer));
 316
 317         /*
 318          * Note we add to the end of the list to ensure
 319          * the messages are sent in the order they were received. JRA.
 320          */
 321
 322         DLIST_ADD_END(notify_queue_head, pnqueue, struct notify_queue *);
 323         num_messages++;
 324
 325         if ((notify_event == NULL) && (smbd_event_context() != NULL)) {
 326                 /* Add an event for 1 second's time to send this queue. */
 327                 notify_event = event_add_timed(smbd_event_context(), NULL,
 328                                         timeval_current_ofs(1,0),
 329                                         "print_notify",
 330                                         print_notify_event_send_messages, NULL);
 331         }
 332
 333 }
 334
 335 static void send_notify_field_values(const char *sharename, uint32 type,
 336                                      uint32 field, uint32 id, uint32 value1,
 337                                      uint32 value2, uint32 flags)
 338 {
 339         struct spoolss_notify_msg *msg;
 340
 341         if (lp_disable_spoolss())
 342                 return;
 343
 344         if (!create_send_ctx())
 345                 return;
 346
 347         msg = TALLOC_P(send_ctx, struct spoolss_notify_msg);
 348         if (!msg)
 349                 return;
 350
 351         ZERO_STRUCTP(msg);
 352
 353         fstrcpy(msg->printer, sharename);
 354         msg->type = type;
 355         msg->field = field;
 356         msg->id = id;
 357         msg->notify.value[0] = value1;
 358         msg->notify.value[1] = value2;
 359         msg->flags = flags;
 360
 361         send_spoolss_notify2_msg(msg);
 362 }
 363
 364 static void send_notify_field_buffer(const char *sharename, uint32 type,
 365                                      uint32 field, uint32 id, uint32 len,
 366                                      const char *buffer)
 367 {
 368         struct spoolss_notify_msg *msg;
 369
 370         if (lp_disable_spoolss())
 371                 return;
 372
 373         if (!create_send_ctx())
 374                 return;
 375
 376         msg = TALLOC_P(send_ctx, struct spoolss_notify_msg);
 377         if (!msg)
 378                 return;
 379
 380         ZERO_STRUCTP(msg);
 381
 382         fstrcpy(msg->printer, sharename);
 383         msg->type = type;
 384         msg->field = field;
 385         msg->id = id;
 386         msg->len = len;
 387         msg->notify.data = CONST_DISCARD(char *,buffer);
 388
 389         send_spoolss_notify2_msg(msg);
 390 }
 391
 392 /* Send a message that the printer status has changed */
 393
 394 void notify_printer_status_byname(const char *sharename, uint32 status)
 395 {
 396         /* Printer status stored in value1 */
 397
 398         send_notify_field_values(sharename, PRINTER_NOTIFY_TYPE,
 399                                  PRINTER_NOTIFY_STATUS, 0,
 400                                  status, 0, 0);
 401 }
 402
 403 void notify_printer_status(int snum, uint32 status)
 404 {
 405         const char *sharename = SERVICE(snum);
 406
 407         if (sharename)
 408                 notify_printer_status_byname(sharename, status);
 409 }
 410
 411 void notify_job_status_byname(const char *sharename, uint32 jobid, uint32 status,
 412                               uint32 flags)
 413 {
 414         /* Job id stored in id field, status in value1 */
 415
 416         send_notify_field_values(sharename, JOB_NOTIFY_TYPE,
 417                                  JOB_NOTIFY_STATUS, jobid,
 418                                  status, 0, flags);
 419 }
 420
 421 void notify_job_status(const char *sharename, uint32 jobid, uint32 status)
 422 {
 423         notify_job_status_byname(sharename, jobid, status, 0);
 424 }
 425
 426 void notify_job_total_bytes(const char *sharename, uint32 jobid,
 427                             uint32 size)
 428 {
 429         /* Job id stored in id field, status in value1 */
 430
 431         send_notify_field_values(sharename, JOB_NOTIFY_TYPE,
 432                                  JOB_NOTIFY_TOTAL_BYTES, jobid,
 433                                  size, 0, 0);
 434 }
 435
 436 void notify_job_total_pages(const char *sharename, uint32 jobid,
 437                             uint32 pages)
 438 {
 439         /* Job id stored in id field, status in value1 */
 440
 441         send_notify_field_values(sharename, JOB_NOTIFY_TYPE,
 442                                  JOB_NOTIFY_TOTAL_PAGES, jobid,
 443                                  pages, 0, 0);
 444 }
 445
 446 void notify_job_username(const char *sharename, uint32 jobid, char *name)
 447 {
 448         send_notify_field_buffer(
 449                 sharename, JOB_NOTIFY_TYPE, JOB_NOTIFY_USER_NAME,
 450                 jobid, strlen(name) + 1, name);
 451 }
 452
 453 void notify_job_name(const char *sharename, uint32 jobid, char *name)
 454 {
 455         send_notify_field_buffer(
 456                 sharename, JOB_NOTIFY_TYPE, JOB_NOTIFY_DOCUMENT,
 457                 jobid, strlen(name) + 1, name);
 458 }
 459
 460 void notify_job_submitted(const char *sharename, uint32 jobid,
 461                           time_t submitted)
 462 {
 463         send_notify_field_buffer(
 464                 sharename, JOB_NOTIFY_TYPE, JOB_NOTIFY_SUBMITTED,
 465                 jobid, sizeof(submitted), (char *)&submitted);
 466 }
 467
 468 void notify_printer_driver(int snum, char *driver_name)
 469 {
 470         const char *sharename = SERVICE(snum);
 471
 472         send_notify_field_buffer(
 473                 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_DRIVER_NAME,
 474                 snum, strlen(driver_name) + 1, driver_name);
 475 }
 476
 477 void notify_printer_comment(int snum, char *comment)
 478 {
 479         const char *sharename = SERVICE(snum);
 480
 481         send_notify_field_buffer(
 482                 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_COMMENT,
 483                 snum, strlen(comment) + 1, comment);
 484 }
 485
 486 void notify_printer_sharename(int snum, char *share_name)
 487 {
 488         const char *sharename = SERVICE(snum);
 489
 490         send_notify_field_buffer(
 491                 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_SHARE_NAME,
 492                 snum, strlen(share_name) + 1, share_name);
 493 }
 494
 495 void notify_printer_printername(int snum, char *printername)
 496 {
 497         const char *sharename = SERVICE(snum);
 498
 499         send_notify_field_buffer(
 500                 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_PRINTER_NAME,
 501                 snum, strlen(printername) + 1, printername);
 502 }
 503
 504 void notify_printer_port(int snum, char *port_name)
 505 {
 506         const char *sharename = SERVICE(snum);
 507
 508         send_notify_field_buffer(
 509                 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_PORT_NAME,
 510                 snum, strlen(port_name) + 1, port_name);
 511 }
 512
 513 void notify_printer_location(int snum, char *location)
 514 {
 515         const char *sharename = SERVICE(snum);
 516
 517         send_notify_field_buffer(
 518                 sharename, PRINTER_NOTIFY_TYPE, PRINTER_NOTIFY_LOCATION,
 519                 snum, strlen(location) + 1, location);
 520 }
 521
 522 void notify_printer_byname( const char *printername, uint32 change, const char *value )
 523 {
 524         int snum = print_queue_snum(printername);
 525         int type = PRINTER_NOTIFY_TYPE;
 526
 527         if ( snum == -1 )
 528                 return;
 529
 530         send_notify_field_buffer( printername, type, change, snum, strlen(value)+1, value );
 531 }
 532
 533
 534 /****************************************************************************
 535  Return a malloced list of pid_t's that are interested in getting update
 536  messages on this print queue. Used in printing/notify to send the messages.
 537 ****************************************************************************/
 538
 539 bool print_notify_pid_list(const char *printername, TALLOC_CTX *mem_ctx, size_t *p_num_pids, pid_t **pp_pid_list)
 540 {
 541         struct tdb_print_db *pdb = NULL;
 542         TDB_CONTEXT *tdb = NULL;
 543         TDB_DATA data;
 544         bool ret = True;
 545         size_t i, num_pids, offset;
 546         pid_t *pid_list;
 547
 548         *p_num_pids = 0;
 549         *pp_pid_list = NULL;
 550
 551         pdb = get_print_db_byname(printername);
 552         if (!pdb)
 553                 return False;
 554         tdb = pdb->tdb;
 555
 556         if (tdb_read_lock_bystring_with_timeout(tdb, NOTIFY_PID_LIST_KEY, 10) == -1) {
 557                 DEBUG(0,("print_notify_pid_list: Failed to lock printer %s database\n",
 558                                         printername));
 559                 if (pdb)
 560                         release_print_db(pdb);
 561                 return False;
 562         }
 563
 564         data = get_printer_notify_pid_list( tdb, printername, True );
 565
 566         if (!data.dptr) {
 567                 ret = True;
 568                 goto done;
 569         }
 570
 571         num_pids = data.dsize / 8;
 572
 573         if (num_pids) {
 574                 if ((pid_list = TALLOC_ARRAY(mem_ctx, pid_t, num_pids)) == NULL) {
 575                         ret = False;
 576                         goto done;
 577                 }
 578         } else {
 579                 pid_list = NULL;
 580         }
 581
 582         for( i = 0, offset = 0; i < num_pids; offset += 8, i++)
 583                 pid_list[i] = (pid_t)IVAL(data.dptr, offset);
 584
 585         *pp_pid_list = pid_list;
 586         *p_num_pids = num_pids;
 587
 588         ret = True;
 589
 590   done:
 591
 592         tdb_read_unlock_bystring(tdb, NOTIFY_PID_LIST_KEY);
 593         if (pdb)
 594                 release_print_db(pdb);
 595         SAFE_FREE(data.dptr);
 596         return ret;
 597 }