2 * "$Id: subscriptions.c 5878 2006-08-24 15:55:42Z mike $"
4 * Subscription routines for the Common UNIX Printing System (CUPS) scheduler.
6 * Copyright 1997-2006 by Easy Software Products, all rights reserved.
8 * These coded instructions, statements, and computer programs are the
9 * property of Easy Software Products and are protected by Federal
10 * copyright law. Distribution and use rights are outlined in the file
11 * "LICENSE.txt" which should have been included with this file. If this
12 * file is missing or damaged please contact Easy Software Products
15 * Attn: CUPS Licensing Information
16 * Easy Software Products
17 * 44141 Airport View Drive, Suite 204
18 * Hollywood, Maryland 20636 USA
20 * Voice: (301) 373-9600
21 * EMail: cups-info@cups.org
22 * WWW: http://www.cups.org
26 * cupsdAddEvent() - Add an event to the global event cache.
27 * cupsdAddSubscription() - Add a new subscription object.
28 * cupsdDeleteAllSubscriptions() - Delete all subscriptions.
29 * cupsdDeleteSubscription() - Delete a subscription object.
30 * cupsdEventName() - Return a single event name.
31 * cupsdEventValue() - Return the event mask value for a name.
32 * cupsdExpireSubscriptions() - Expire old subscription objects.
33 * cupsdFindSubscription() - Find a subscription by ID.
34 * cupsdLoadAllSubscriptions() - Load all subscriptions from the .conf file.
35 * cupsdSaveAllSubscriptions() - Save all subscriptions to the .conf file.
36 * cupsdStopAllNotifiers() - Stop all notifier processes.
37 * cupsdUpdateNotifierStatus() - Read messages from notifiers.
38 * cupsd_compare_subscriptions() - Compare two subscriptions.
39 * cupsd_delete_event() - Delete a single event...
40 * cupsd_send_dbus() - Send a DBUS notification...
41 * cupsd_send_notification() - Send a notification for the specified
43 * cupsd_start_notifier() - Start a notifier subprocess...
47 * Include necessary headers...
52 # include <dbus/dbus.h>
53 #endif /* HAVE_DBUS */
60 static int cupsd_compare_subscriptions(cupsd_subscription_t
*first
,
61 cupsd_subscription_t
*second
,
63 static void cupsd_delete_event(cupsd_event_t
*event
);
65 static void cupsd_send_dbus(cupsd_eventmask_t event
, cupsd_printer_t
*dest
,
67 #endif /* HAVE_DBUS */
68 static void cupsd_send_notification(cupsd_subscription_t
*sub
,
69 cupsd_event_t
*event
);
70 static void cupsd_start_notifier(cupsd_subscription_t
*sub
);
74 * 'cupsdAddEvent()' - Add an event to the global event cache.
79 cupsd_eventmask_t event
, /* I - Event */
80 cupsd_printer_t
*dest
, /* I - Printer associated with event */
81 cupsd_job_t
*job
, /* I - Job associated with event */
82 const char *text
, /* I - Notification text */
83 ...) /* I - Additional arguments as needed */
85 va_list ap
; /* Pointer to additional arguments */
86 char ftext
[1024]; /* Formatted text buffer */
87 ipp_attribute_t
*attr
; /* Printer/job attribute */
88 cupsd_event_t
*temp
; /* New event pointer */
89 cupsd_subscription_t
*sub
; /* Current subscription */
92 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
93 "cupsdAddEvent(event=%s, dest=%p(%s), job=%p(%d), text=\"%s\", ...)",
94 cupsdEventName(event
), dest
, dest
? dest
->name
: "",
95 job
, job
? job
->id
: 0, text
);
98 * Keep track of events with any OS-supplied notification mechanisms...
104 cupsd_send_dbus(event
, dest
, job
);
105 #endif /* HAVE_DBUS */
108 * Return if we aren't keeping events...
113 cupsdLogMessage(CUPSD_LOG_WARN
,
114 "cupsdAddEvent: Discarding %s event since MaxEvents is %d!",
115 cupsdEventName(event
), MaxEvents
);
120 * Then loop through the subscriptions and add the event to the corresponding
124 for (temp
= NULL
, sub
= (cupsd_subscription_t
*)cupsArrayFirst(Subscriptions
);
126 sub
= (cupsd_subscription_t
*)cupsArrayNext(Subscriptions
))
129 * Check if this subscription requires this event...
132 if ((sub
->mask
& event
) != 0 &&
133 (sub
->dest
== dest
|| !sub
->dest
) &&
134 (sub
->job
== job
|| !sub
->job
))
137 * Need this event, so create a new event record...
140 if ((temp
= (cupsd_event_t
*)calloc(1, sizeof(cupsd_event_t
))) == NULL
)
142 cupsdLogMessage(CUPSD_LOG_CRIT
,
143 "Unable to allocate memory for event - %s",
149 temp
->time
= time(NULL
);
150 temp
->attrs
= ippNew();
155 * Add common event notification attributes...
158 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
, IPP_TAG_CHARSET
,
159 "notify-charset", NULL
, "utf-8");
161 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
, IPP_TAG_LANGUAGE
,
162 "notify-natural-langugage", NULL
, "en-US");
164 ippAddInteger(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
, IPP_TAG_INTEGER
,
165 "notify-subscription-id", sub
->id
);
167 ippAddInteger(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
, IPP_TAG_INTEGER
,
168 "notify-sequence-number", sub
->next_event_id
);
170 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
, IPP_TAG_KEYWORD
,
171 "notify-subscribed-event", NULL
, cupsdEventName(event
));
173 if (sub
->user_data_len
> 0)
174 ippAddOctetString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
,
175 "notify-user-data", sub
->user_data
,
178 ippAddInteger(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
, IPP_TAG_INTEGER
,
179 "printer-up-time", time(NULL
));
182 vsnprintf(ftext
, sizeof(ftext
), text
, ap
);
185 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
, IPP_TAG_TEXT
,
186 "notify-text", NULL
, ftext
);
191 * Add printer attributes...
194 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
, IPP_TAG_URI
,
195 "notify-printer-uri", NULL
, dest
->uri
);
197 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
, IPP_TAG_NAME
,
198 "printer-name", NULL
, dest
->name
);
200 ippAddInteger(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
, IPP_TAG_ENUM
,
201 "printer-state", dest
->state
);
203 if (dest
->num_reasons
== 0)
204 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
,
205 IPP_TAG_KEYWORD
, "printer-state-reasons", NULL
,
206 dest
->state
== IPP_PRINTER_STOPPED
? "paused" : "none");
208 ippAddStrings(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
,
209 IPP_TAG_KEYWORD
, "printer-state-reasons",
210 dest
->num_reasons
, NULL
,
211 (const char * const *)dest
->reasons
);
213 ippAddBoolean(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
,
214 "printer-is-accepting-jobs", dest
->accepting
);
220 * Add job attributes...
223 ippAddInteger(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
, IPP_TAG_INTEGER
,
224 "notify-job-id", job
->id
);
225 ippAddInteger(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
, IPP_TAG_ENUM
,
226 "job-state", job
->state_value
);
228 if ((attr
= ippFindAttribute(job
->attrs
, "job-name",
229 IPP_TAG_NAME
)) != NULL
)
230 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
, IPP_TAG_NAME
,
231 "job-name", NULL
, attr
->values
[0].string
.text
);
233 switch (job
->state_value
)
235 case IPP_JOB_PENDING
:
236 if (dest
&& dest
->state
== IPP_PRINTER_STOPPED
)
237 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
,
238 IPP_TAG_KEYWORD
, "job-state-reasons", NULL
,
241 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
,
242 IPP_TAG_KEYWORD
, "job-state-reasons", NULL
,
247 if (ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_KEYWORD
) != NULL
||
248 ippFindAttribute(job
->attrs
, "job-hold-until", IPP_TAG_NAME
) != NULL
)
249 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
,
250 IPP_TAG_KEYWORD
, "job-state-reasons", NULL
,
251 "job-hold-until-specified");
253 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
,
254 IPP_TAG_KEYWORD
, "job-state-reasons", NULL
,
258 case IPP_JOB_PROCESSING
:
259 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
,
260 IPP_TAG_KEYWORD
, "job-state-reasons", NULL
,
264 case IPP_JOB_STOPPED
:
265 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
,
266 IPP_TAG_KEYWORD
, "job-state-reasons", NULL
,
270 case IPP_JOB_CANCELED
:
271 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
,
272 IPP_TAG_KEYWORD
, "job-state-reasons", NULL
,
273 "job-canceled-by-user");
276 case IPP_JOB_ABORTED
:
277 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
,
278 IPP_TAG_KEYWORD
, "job-state-reasons", NULL
,
279 "aborted-by-system");
282 case IPP_JOB_COMPLETED
:
283 ippAddString(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
,
284 IPP_TAG_KEYWORD
, "job-state-reasons", NULL
,
285 "job-completed-successfully");
289 ippAddInteger(temp
->attrs
, IPP_TAG_EVENT_NOTIFICATION
, IPP_TAG_INTEGER
,
290 "job-impressions-completed",
291 job
->sheets
? job
->sheets
->values
[0].integer
: 0);
295 * Send the notification for this subscription...
298 cupsd_send_notification(sub
, temp
);
303 cupsdSaveAllSubscriptions();
305 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Discarding unused %s event...",
306 cupsdEventName(event
));
311 * 'cupsdAddSubscription()' - Add a new subscription object.
314 cupsd_subscription_t
* /* O - New subscription object */
315 cupsdAddSubscription(
316 unsigned mask
, /* I - Event mask */
317 cupsd_printer_t
*dest
, /* I - Printer, if any */
318 cupsd_job_t
*job
, /* I - Job, if any */
319 const char *uri
, /* I - notify-recipient-uri, if any */
320 int sub_id
) /* I - notify-subscription-id or 0 */
322 cupsd_subscription_t
*temp
; /* New subscription object */
325 cupsdLogMessage(CUPSD_LOG_DEBUG
,
326 "cupsdAddSubscription(mask=%x, dest=%p(%s), job=%p(%d), "
328 mask
, dest
, dest
? dest
->name
: "", job
, job
? job
->id
: 0,
332 Subscriptions
= cupsArrayNew((cups_array_func_t
)cupsd_compare_subscriptions
,
337 cupsdLogMessage(CUPSD_LOG_CRIT
,
338 "Unable to allocate memory for subscriptions - %s",
344 * Limit the number of subscriptions...
347 if (cupsArrayCount(Subscriptions
) >= MaxSubscriptions
)
351 * Allocate memory for this subscription...
354 if ((temp
= calloc(1, sizeof(cupsd_subscription_t
))) == NULL
)
356 cupsdLogMessage(CUPSD_LOG_CRIT
,
357 "Unable to allocate memory for subscription object - %s",
363 * Fill in common data...
370 if (sub_id
>= NextSubscriptionId
)
371 NextSubscriptionId
= sub_id
+ 1;
375 temp
->id
= NextSubscriptionId
;
377 NextSubscriptionId
++;
384 temp
->first_event_id
= 1;
385 temp
->next_event_id
= 1;
387 cupsdSetString(&(temp
->recipient
), uri
);
390 * Add the subscription to the array...
393 cupsArrayAdd(Subscriptions
, temp
);
400 * 'cupsdDeleteAllSubscriptions()' - Delete all subscriptions.
404 cupsdDeleteAllSubscriptions(void)
406 cupsd_subscription_t
*sub
; /* Subscription */
412 for (sub
= (cupsd_subscription_t
*)cupsArrayFirst(Subscriptions
);
414 sub
= (cupsd_subscription_t
*)cupsArrayNext(Subscriptions
))
415 cupsdDeleteSubscription(sub
, 0);
417 cupsArrayDelete(Subscriptions
);
418 Subscriptions
= NULL
;
423 * 'cupsdDeleteSubscription()' - Delete a subscription object.
427 cupsdDeleteSubscription(
428 cupsd_subscription_t
*sub
, /* I - Subscription object */
429 int update
) /* I - 1 = update subscriptions.conf */
431 int i
; /* Looping var */
435 * Close the pipe to the notifier as needed...
442 * Remove subscription from array...
445 cupsArrayRemove(Subscriptions
, sub
);
451 cupsdClearString(&(sub
->owner
));
452 cupsdClearString(&(sub
->recipient
));
456 for (i
= 0; i
< sub
->num_events
; i
++)
457 cupsd_delete_event(sub
->events
[i
]);
465 * Update the subscriptions as needed...
469 cupsdSaveAllSubscriptions();
474 * 'cupsdEventName()' - Return a single event name.
477 const char * /* O - Event name */
479 cupsd_eventmask_t event
) /* I - Event value */
486 case CUPSD_EVENT_PRINTER_RESTARTED
:
487 return ("printer-restarted");
489 case CUPSD_EVENT_PRINTER_SHUTDOWN
:
490 return ("printer-shutdown");
492 case CUPSD_EVENT_PRINTER_STOPPED
:
493 return ("printer-stopped");
495 case CUPSD_EVENT_PRINTER_FINISHINGS_CHANGED
:
496 return ("printer-finishings-changed");
498 case CUPSD_EVENT_PRINTER_MEDIA_CHANGED
:
499 return ("printer-media-changed");
501 case CUPSD_EVENT_PRINTER_ADDED
:
502 return ("printer-added");
504 case CUPSD_EVENT_PRINTER_DELETED
:
505 return ("printer-deleted");
507 case CUPSD_EVENT_PRINTER_MODIFIED
:
508 return ("printer-modified");
510 case CUPSD_EVENT_PRINTER_STATE_CHANGED
:
511 return ("printer-state-changed");
513 case CUPSD_EVENT_PRINTER_CONFIG_CHANGED
:
514 return ("printer-config-changed");
516 case CUPSD_EVENT_PRINTER_CHANGED
:
517 return ("printer-changed");
519 case CUPSD_EVENT_JOB_CREATED
:
520 return ("job-created");
522 case CUPSD_EVENT_JOB_COMPLETED
:
523 return ("job-completed");
525 case CUPSD_EVENT_JOB_STOPPED
:
526 return ("job-stopped");
528 case CUPSD_EVENT_JOB_CONFIG_CHANGED
:
529 return ("job-config-changed");
531 case CUPSD_EVENT_JOB_PROGRESS
:
532 return ("job-progress");
534 case CUPSD_EVENT_JOB_STATE
:
535 return ("job-state");
537 case CUPSD_EVENT_JOB_STATE_CHANGED
:
538 return ("job-state-changed");
540 case CUPSD_EVENT_SERVER_RESTARTED
:
541 return ("server-restarted");
543 case CUPSD_EVENT_SERVER_STARTED
:
544 return ("server-started");
546 case CUPSD_EVENT_SERVER_STOPPED
:
547 return ("server-stopped");
549 case CUPSD_EVENT_SERVER_AUDIT
:
550 return ("server-audit");
552 case CUPSD_EVENT_ALL
:
559 * 'cupsdEventValue()' - Return the event mask value for a name.
562 cupsd_eventmask_t
/* O - Event mask value */
563 cupsdEventValue(const char *name
) /* I - Name of event */
565 if (!strcmp(name
, "all"))
566 return (CUPSD_EVENT_ALL
);
567 else if (!strcmp(name
, "printer-restarted"))
568 return (CUPSD_EVENT_PRINTER_RESTARTED
);
569 else if (!strcmp(name
, "printer-shutdown"))
570 return (CUPSD_EVENT_PRINTER_SHUTDOWN
);
571 else if (!strcmp(name
, "printer-stopped"))
572 return (CUPSD_EVENT_PRINTER_STOPPED
);
573 else if (!strcmp(name
, "printer-finishings-changed"))
574 return (CUPSD_EVENT_PRINTER_FINISHINGS_CHANGED
);
575 else if (!strcmp(name
, "printer-media-changed"))
576 return (CUPSD_EVENT_PRINTER_MEDIA_CHANGED
);
577 else if (!strcmp(name
, "printer-added"))
578 return (CUPSD_EVENT_PRINTER_ADDED
);
579 else if (!strcmp(name
, "printer-deleted"))
580 return (CUPSD_EVENT_PRINTER_DELETED
);
581 else if (!strcmp(name
, "printer-modified"))
582 return (CUPSD_EVENT_PRINTER_MODIFIED
);
583 else if (!strcmp(name
, "printer-state-changed"))
584 return (CUPSD_EVENT_PRINTER_STATE_CHANGED
);
585 else if (!strcmp(name
, "printer-config-changed"))
586 return (CUPSD_EVENT_PRINTER_CONFIG_CHANGED
);
587 else if (!strcmp(name
, "printer-changed"))
588 return (CUPSD_EVENT_PRINTER_CHANGED
);
589 else if (!strcmp(name
, "job-state"))
590 return (CUPSD_EVENT_JOB_STATE
);
591 else if (!strcmp(name
, "job-created"))
592 return (CUPSD_EVENT_JOB_CREATED
);
593 else if (!strcmp(name
, "job-completed"))
594 return (CUPSD_EVENT_JOB_COMPLETED
);
595 else if (!strcmp(name
, "job-stopped"))
596 return (CUPSD_EVENT_JOB_STOPPED
);
597 else if (!strcmp(name
, "job-config-changed"))
598 return (CUPSD_EVENT_JOB_CONFIG_CHANGED
);
599 else if (!strcmp(name
, "job-progress"))
600 return (CUPSD_EVENT_JOB_PROGRESS
);
601 else if (!strcmp(name
, "job-state-changed"))
602 return (CUPSD_EVENT_JOB_STATE_CHANGED
);
603 else if (!strcmp(name
, "server-restarted"))
604 return (CUPSD_EVENT_SERVER_RESTARTED
);
605 else if (!strcmp(name
, "server-started"))
606 return (CUPSD_EVENT_SERVER_STARTED
);
607 else if (!strcmp(name
, "server-stopped"))
608 return (CUPSD_EVENT_SERVER_STOPPED
);
609 else if (!strcmp(name
, "server-audit"))
610 return (CUPSD_EVENT_SERVER_AUDIT
);
612 return (CUPSD_EVENT_NONE
);
617 * 'cupsdExpireSubscriptions()' - Expire old subscription objects.
621 cupsdExpireSubscriptions(
622 cupsd_printer_t
*dest
, /* I - Printer, if any */
623 cupsd_job_t
*job
) /* I - Job, if any */
625 cupsd_subscription_t
*sub
; /* Current subscription */
626 int update
; /* Update subscriptions.conf? */
627 time_t curtime
; /* Current time */
630 curtime
= time(NULL
);
633 for (sub
= (cupsd_subscription_t
*)cupsArrayFirst(Subscriptions
);
635 sub
= (cupsd_subscription_t
*)cupsArrayNext(Subscriptions
))
636 if ((!sub
->job
&& !dest
&& sub
->expire
&& sub
->expire
<= curtime
) ||
637 (dest
&& sub
->dest
== dest
) ||
638 (job
&& sub
->job
== job
))
640 cupsdLogMessage(CUPSD_LOG_INFO
, "Subscription %d has expired...",
643 cupsdDeleteSubscription(sub
, 0);
649 cupsdSaveAllSubscriptions();
654 * 'cupsdFindSubscription()' - Find a subscription by ID.
657 cupsd_subscription_t
* /* O - Subscription object */
658 cupsdFindSubscription(int id
) /* I - Subscription ID */
660 cupsd_subscription_t sub
; /* Subscription template */
665 return ((cupsd_subscription_t
*)cupsArrayFind(Subscriptions
, &sub
));
670 * 'cupsdLoadAllSubscriptions()' - Load all subscriptions from the .conf file.
674 cupsdLoadAllSubscriptions(void)
676 int i
; /* Looping var */
677 cups_file_t
*fp
; /* subscriptions.conf file */
678 int linenum
; /* Current line number */
679 char line
[1024], /* Line from file */
680 *value
, /* Pointer to value */
681 *valueptr
; /* Pointer into value */
682 cupsd_subscription_t
*sub
; /* Current subscription */
683 int hex
; /* Non-zero if reading hex data */
684 int delete_sub
; /* Delete subscription? */
688 * Open the subscriptions.conf file...
691 snprintf(line
, sizeof(line
), "%s/subscriptions.conf", ServerRoot
);
692 if ((fp
= cupsFileOpen(line
, "r")) == NULL
)
695 cupsdLogMessage(CUPSD_LOG_ERROR
,
696 "LoadAllSubscriptions: Unable to open %s - %s", line
,
702 * Read all of the lines from the file...
709 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
711 if (!strcasecmp(line
, "NextSubscriptionId") && value
)
714 * NextSubscriptionId NNN
718 if (i
>= NextSubscriptionId
&& i
> 0)
719 NextSubscriptionId
= i
;
721 else if (!strcasecmp(line
, "<Subscription"))
727 if (!sub
&& value
&& isdigit(value
[0] & 255))
729 sub
= cupsdAddSubscription(CUPSD_EVENT_NONE
, NULL
, NULL
, NULL
,
734 cupsdLogMessage(CUPSD_LOG_ERROR
,
735 "Syntax error on line %d of subscriptions.conf.",
740 else if (!strcasecmp(line
, "</Subscription>"))
744 cupsdLogMessage(CUPSD_LOG_ERROR
,
745 "Syntax error on line %d of subscriptions.conf.",
751 cupsdDeleteSubscription(sub
, 0);
758 cupsdLogMessage(CUPSD_LOG_ERROR
,
759 "Syntax error on line %d of subscriptions.conf.",
763 else if (!strcasecmp(line
, "Events"))
767 * Events name name name ...
772 cupsdLogMessage(CUPSD_LOG_ERROR
,
773 "Syntax error on line %d of subscriptions.conf.",
781 * Separate event names...
784 for (valueptr
= value
; !isspace(*valueptr
) && *valueptr
; valueptr
++);
786 while (isspace(*valueptr
& 255))
790 * See if the name exists...
793 if ((sub
->mask
|= cupsdEventValue(value
)) == CUPSD_EVENT_NONE
)
795 cupsdLogMessage(CUPSD_LOG_ERROR
,
796 "Unknown event name \'%s\' on line %d of subscriptions.conf.",
804 else if (!strcasecmp(line
, "Owner"))
811 cupsdSetString(&sub
->owner
, value
);
814 cupsdLogMessage(CUPSD_LOG_ERROR
,
815 "Syntax error on line %d of subscriptions.conf.",
820 else if (!strcasecmp(line
, "Recipient"))
827 cupsdSetString(&sub
->recipient
, value
);
830 cupsdLogMessage(CUPSD_LOG_ERROR
,
831 "Syntax error on line %d of subscriptions.conf.",
836 else if (!strcasecmp(line
, "JobId"))
842 if (value
&& isdigit(*value
& 255))
844 if ((sub
->job
= cupsdFindJob(atoi(value
))) == NULL
)
846 cupsdLogMessage(CUPSD_LOG_ERROR
,
847 "Job %s not found on line %d of subscriptions.conf.",
854 cupsdLogMessage(CUPSD_LOG_ERROR
,
855 "Syntax error on line %d of subscriptions.conf.",
860 else if (!strcasecmp(line
, "PrinterName"))
868 if ((sub
->dest
= cupsdFindDest(value
)) == NULL
)
870 cupsdLogMessage(CUPSD_LOG_ERROR
,
871 "Printer \'%s\' not found on line %d of subscriptions.conf.",
878 cupsdLogMessage(CUPSD_LOG_ERROR
,
879 "Syntax error on line %d of subscriptions.conf.",
884 else if (!strcasecmp(line
, "UserData"))
887 * UserData encoded-string
892 for (i
= 0, valueptr
= value
, hex
= 0; i
< 63 && *valueptr
; i
++)
894 if (*valueptr
== '<' && !hex
)
902 if (isxdigit(valueptr
[0]) && isxdigit(valueptr
[1]))
904 if (isdigit(valueptr
[0]))
905 sub
->user_data
[i
] = (valueptr
[0] - '0') << 4;
907 sub
->user_data
[i
] = (tolower(valueptr
[0]) - 'a' + 10) << 4;
909 if (isdigit(valueptr
[1]))
910 sub
->user_data
[i
] |= valueptr
[1] - '0';
912 sub
->user_data
[i
] |= tolower(valueptr
[1]) - 'a' + 10;
916 if (*valueptr
== '>')
926 sub
->user_data
[i
] = *valueptr
++;
931 cupsdLogMessage(CUPSD_LOG_ERROR
,
932 "Bad UserData \'%s\' on line %d of subscriptions.conf.",
936 sub
->user_data_len
= i
;
940 cupsdLogMessage(CUPSD_LOG_ERROR
,
941 "Syntax error on line %d of subscriptions.conf.",
946 else if (!strcasecmp(line
, "LeaseDuration"))
952 if (value
&& isdigit(*value
& 255))
954 sub
->lease
= atoi(value
);
955 sub
->expire
= sub
->lease
? time(NULL
) + sub
->lease
: 0;
959 cupsdLogMessage(CUPSD_LOG_ERROR
,
960 "Syntax error on line %d of subscriptions.conf.",
965 else if (!strcasecmp(line
, "Interval"))
971 if (value
&& isdigit(*value
& 255))
972 sub
->interval
= atoi(value
);
975 cupsdLogMessage(CUPSD_LOG_ERROR
,
976 "Syntax error on line %d of subscriptions.conf.",
981 else if (!strcasecmp(line
, "ExpirationTime"))
987 if (value
&& isdigit(*value
& 255))
988 sub
->expire
= atoi(value
);
991 cupsdLogMessage(CUPSD_LOG_ERROR
,
992 "Syntax error on line %d of subscriptions.conf.",
997 else if (!strcasecmp(line
, "NextEventId"))
1003 if (value
&& isdigit(*value
& 255))
1004 sub
->next_event_id
= sub
->first_event_id
= atoi(value
);
1007 cupsdLogMessage(CUPSD_LOG_ERROR
,
1008 "Syntax error on line %d of subscriptions.conf.",
1016 * Something else we don't understand...
1019 cupsdLogMessage(CUPSD_LOG_ERROR
,
1020 "Unknown configuration directive %s on line %d of subscriptions.conf.",
1030 * 'cupsdSaveAllSubscriptions()' - Save all subscriptions to the .conf file.
1034 cupsdSaveAllSubscriptions(void)
1036 int i
; /* Looping var */
1037 cups_file_t
*fp
; /* subscriptions.conf file */
1038 char temp
[1024]; /* Temporary string */
1039 char backup
[1024]; /* subscriptions.conf.O file */
1040 cupsd_subscription_t
*sub
; /* Current subscription */
1041 time_t curtime
; /* Current time */
1042 struct tm
*curdate
; /* Current date */
1043 unsigned mask
; /* Current event mask */
1044 const char *name
; /* Current event name */
1045 int hex
; /* Non-zero if we are writing hex data */
1049 * Create the subscriptions.conf file...
1052 snprintf(temp
, sizeof(temp
), "%s/subscriptions.conf", ServerRoot
);
1053 snprintf(backup
, sizeof(backup
), "%s/subscriptions.conf.O", ServerRoot
);
1055 if (rename(temp
, backup
))
1057 if (errno
!= ENOENT
)
1058 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to backup subscriptions.conf - %s",
1062 if ((fp
= cupsFileOpen(temp
, "w")) == NULL
)
1064 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to save subscriptions.conf - %s",
1067 if (rename(backup
, temp
))
1068 cupsdLogMessage(CUPSD_LOG_ERROR
,
1069 "Unable to restore subscriptions.conf - %s",
1074 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving subscriptions.conf...");
1077 * Restrict access to the file...
1080 fchown(cupsFileNumber(fp
), getuid(), Group
);
1081 fchmod(cupsFileNumber(fp
), ConfigFilePerm
);
1084 * Write a small header to the file...
1087 curtime
= time(NULL
);
1088 curdate
= localtime(&curtime
);
1089 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
1091 cupsFilePuts(fp
, "# Subscription configuration file for " CUPS_SVERSION
"\n");
1092 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
1094 cupsFilePrintf(fp
, "NextSubscriptionId %d\n", NextSubscriptionId
);
1097 * Write every subscription known to the system...
1100 for (sub
= (cupsd_subscription_t
*)cupsArrayFirst(Subscriptions
);
1102 sub
= (cupsd_subscription_t
*)cupsArrayNext(Subscriptions
))
1104 cupsFilePrintf(fp
, "<Subscription %d>\n", sub
->id
);
1106 if ((name
= cupsdEventName((cupsd_eventmask_t
)sub
->mask
)) != NULL
)
1109 * Simple event list...
1112 cupsFilePrintf(fp
, "Events %s\n", name
);
1117 * Complex event list...
1120 cupsFilePuts(fp
, "Events");
1122 for (mask
= 1; mask
< CUPSD_EVENT_ALL
; mask
<<= 1)
1123 if (sub
->mask
& mask
)
1124 cupsFilePrintf(fp
, " %s", cupsdEventName((cupsd_eventmask_t
)mask
));
1126 cupsFilePuts(fp
, "\n");
1130 cupsFilePrintf(fp
, "Owner %s\n", sub
->owner
);
1132 cupsFilePrintf(fp
, "Recipient %s\n", sub
->recipient
);
1134 cupsFilePrintf(fp
, "JobId %d\n", sub
->job
->id
);
1136 cupsFilePrintf(fp
, "PrinterName %s\n", sub
->dest
->name
);
1138 if (sub
->user_data_len
> 0)
1140 cupsFilePuts(fp
, "UserData ");
1142 for (i
= 0, hex
= 0; i
< sub
->user_data_len
; i
++)
1144 if (sub
->user_data
[i
] < ' ' ||
1145 sub
->user_data
[i
] > 0x7f ||
1146 sub
->user_data
[i
] == '<')
1150 cupsFilePrintf(fp
, "<%02X", sub
->user_data
[i
]);
1154 cupsFilePrintf(fp
, "%02X", sub
->user_data
[i
]);
1160 cupsFilePrintf(fp
, ">%c", sub
->user_data
[i
]);
1164 cupsFilePutChar(fp
, sub
->user_data
[i
]);
1169 cupsFilePuts(fp
, ">\n");
1171 cupsFilePutChar(fp
, '\n');
1174 cupsFilePrintf(fp
, "LeaseDuration %d\n", sub
->lease
);
1175 cupsFilePrintf(fp
, "Interval %d\n", sub
->interval
);
1176 cupsFilePrintf(fp
, "ExpirationTime %ld\n", (long)sub
->expire
);
1177 cupsFilePrintf(fp
, "NextEventId %d\n", sub
->next_event_id
);
1179 cupsFilePuts(fp
, "</Subscription>\n");
1187 * 'cupsdStopAllNotifiers()' - Stop all notifier processes.
1191 cupsdStopAllNotifiers(void)
1193 cupsd_subscription_t
*sub
; /* Current subscription */
1197 * See if we have started any notifiers...
1200 if (!NotifierStatusBuffer
)
1204 * Yes, kill any processes that are left...
1207 for (sub
= (cupsd_subscription_t
*)cupsArrayFirst(Subscriptions
);
1209 sub
= (cupsd_subscription_t
*)cupsArrayNext(Subscriptions
))
1212 cupsdEndProcess(sub
->pid
, 0);
1219 * Close the status pipes...
1222 if (NotifierPipes
[0] >= 0)
1224 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
1225 "cupsdStopAllNotifiers: Removing fd %d from InputSet...",
1227 FD_CLR(NotifierPipes
[0], InputSet
);
1229 cupsdStatBufDelete(NotifierStatusBuffer
);
1231 close(NotifierPipes
[0]);
1232 close(NotifierPipes
[1]);
1234 NotifierPipes
[0] = -1;
1235 NotifierPipes
[1] = -1;
1236 NotifierStatusBuffer
= NULL
;
1242 * 'cupsdUpdateNotifierStatus()' - Read messages from notifiers.
1246 cupsdUpdateNotifierStatus(void)
1248 char message
[1024]; /* Pointer to message text */
1249 int loglevel
; /* Log level for message */
1252 while (cupsdStatBufUpdate(NotifierStatusBuffer
, &loglevel
,
1253 message
, sizeof(message
)))
1254 if (!strchr(NotifierStatusBuffer
->buffer
, '\n'))
1260 * 'cupsd_compare_subscriptions()' - Compare two subscriptions.
1263 static int /* O - Result of comparison */
1264 cupsd_compare_subscriptions(
1265 cupsd_subscription_t
*first
, /* I - First subscription object */
1266 cupsd_subscription_t
*second
, /* I - Second subscription object */
1267 void *unused
) /* I - Unused user data pointer */
1271 return (first
->id
- second
->id
);
1276 * 'cupsd_delete_event()' - Delete a single event...
1278 * Oldest events must be deleted first, otherwise the subscription cache
1279 * flushing code will not work properly.
1283 cupsd_delete_event(cupsd_event_t
*event
)/* I - Event to delete */
1289 ippDelete(event
->attrs
);
1296 * 'cupsd_send_dbus()' - Send a DBUS notification...
1300 cupsd_send_dbus(cupsd_eventmask_t event
,/* I - Event to send */
1301 cupsd_printer_t
*dest
,/* I - Destination, if any */
1302 cupsd_job_t
*job
) /* I - Job, if any */
1304 DBusError error
; /* Error, if any */
1305 DBusMessage
*message
; /* Message to send */
1306 DBusMessageIter iter
; /* Iterator for message data */
1307 const char *what
; /* What to send */
1308 static DBusConnection
*con
= NULL
; /* Connection to DBUS server */
1312 * Figure out what to send, if anything...
1315 if (event
& CUPSD_EVENT_PRINTER_ADDED
)
1316 what
= "PrinterAdded";
1317 else if (event
& CUPSD_EVENT_PRINTER_DELETED
)
1318 what
= "PrinterRemoved";
1319 else if (event
& CUPSD_EVENT_PRINTER_CHANGED
)
1320 what
= "QueueChanged";
1321 else if (event
& CUPSD_EVENT_JOB_CREATED
)
1322 what
= "JobQueuedLocal";
1323 else if ((event
& CUPSD_EVENT_JOB_STATE
) && job
&&
1324 job
->state_value
== IPP_JOB_PROCESSING
)
1325 what
= "JobStartedLocal";
1330 * Verify connection to DBUS server...
1333 if (con
&& !dbus_connection_get_is_connected(con
))
1335 dbus_connection_unref(con
);
1341 dbus_error_init(&error
);
1343 con
= dbus_bus_get(getuid() ? DBUS_BUS_SESSION
: DBUS_BUS_SYSTEM
, &error
);
1346 dbus_error_free(&error
);
1352 * Create and send the new message...
1355 message
= dbus_message_new_signal("/com/redhat/PrinterSpooler",
1356 "com.redhat.PrinterSpooler", what
);
1358 dbus_message_iter_init_append(message
, &iter
);
1360 dbus_message_iter_append_basic(&iter
, DBUS_TYPE_STRING
, &(dest
->name
));
1363 dbus_message_iter_append_basic(&iter
, DBUS_TYPE_UINT32
, &(job
->id
));
1364 dbus_message_iter_append_basic(&iter
, DBUS_TYPE_STRING
, &(job
->username
));
1367 dbus_connection_send(con
, message
, NULL
);
1368 dbus_connection_flush(con
);
1369 dbus_message_unref(message
);
1371 #endif /* HAVE_DBUS */
1375 * 'cupsd_send_notification()' - Send a notification for the specified event.
1379 cupsd_send_notification(
1380 cupsd_subscription_t
*sub
, /* I - Subscription object */
1381 cupsd_event_t
*event
) /* I - Event to send */
1383 ipp_state_t state
; /* IPP event state */
1386 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
1387 "cupsd_send_notification(sub=%p(%d), event=%p(%s))\n",
1388 sub
, sub
->id
, event
, cupsdEventName(event
->event
));
1391 * Allocate the events array as needed...
1396 sub
->events
= calloc(MaxEvents
, sizeof(cupsd_event_t
*));
1400 cupsdLogMessage(CUPSD_LOG_CRIT
,
1401 "Unable to allocate memory for subscription #%d!",
1408 * Purge an old event as needed...
1411 if (sub
->num_events
>= MaxEvents
)
1414 * Purge the oldest event in the cache...
1417 cupsd_delete_event(sub
->events
[0]);
1420 sub
->first_event_id
++;
1422 memmove(sub
->events
, sub
->events
+ 1,
1423 sub
->num_events
* sizeof(cupsd_event_t
*));
1427 * Add the event to the subscription. Since the events array is
1428 * always MaxEvents in length, and since we will have already
1429 * removed an event from the subscription cache if we hit the
1430 * event cache limit, we don't need to check for overflow here...
1433 sub
->events
[sub
->num_events
] = event
;
1437 * Deliver the event...
1445 cupsd_start_notifier(sub
);
1447 cupsdLogMessage(CUPSD_LOG_DEBUG2
, "sub->pipe=%d", sub
->pipe
);
1452 event
->attrs
->state
= IPP_IDLE
;
1454 while ((state
= ippWriteFile(sub
->pipe
, event
->attrs
)) != IPP_DATA
)
1455 if (state
== IPP_ERROR
)
1458 if (state
== IPP_ERROR
)
1463 * Notifier died, try restarting it...
1466 cupsdLogMessage(CUPSD_LOG_WARN
,
1467 "Notifier for subscription %d (%s) went away, "
1469 sub
->id
, sub
->recipient
);
1470 cupsdEndProcess(sub
->pid
, 0);
1477 cupsdLogMessage(CUPSD_LOG_ERROR
,
1478 "Unable to send event for subscription %d (%s)!",
1479 sub
->id
, sub
->recipient
);
1483 * If we get this far, break out of the loop...
1491 * Bump the event sequence number...
1494 sub
->next_event_id
++;
1499 * 'cupsd_start_notifier()' - Start a notifier subprocess...
1503 cupsd_start_notifier(
1504 cupsd_subscription_t
*sub
) /* I - Subscription object */
1506 int pid
; /* Notifier process ID */
1507 int fds
[2]; /* Pipe file descriptors */
1508 char *argv
[4], /* Command-line arguments */
1509 *envp
[MAX_ENV
], /* Environment variables */
1510 user_data
[128], /* Base-64 encoded user data */
1511 scheme
[256], /* notify-recipient-uri scheme */
1512 *ptr
, /* Pointer into scheme */
1513 command
[1024]; /* Notifier command */
1517 * Extract the scheme name from the recipient URI and point to the
1518 * notifier program...
1521 strlcpy(scheme
, sub
->recipient
, sizeof(scheme
));
1522 if ((ptr
= strchr(scheme
, ':')) != NULL
)
1525 snprintf(command
, sizeof(command
), "%s/notifier/%s", ServerBin
, scheme
);
1528 * Base-64 encode the user data...
1531 httpEncode64_2(user_data
, sizeof(user_data
), (char *)sub
->user_data
,
1532 sub
->user_data_len
);
1535 * Setup the argument array...
1539 argv
[1] = sub
->recipient
;
1540 argv
[2] = user_data
;
1544 * Setup the environment...
1547 cupsdLoadEnv(envp
, (int)(sizeof(envp
) / sizeof(envp
[0])));
1550 * Create pipes as needed...
1553 if (!NotifierStatusBuffer
)
1556 * Create the status pipe...
1559 if (cupsdOpenPipe(NotifierPipes
))
1561 cupsdLogMessage(CUPSD_LOG_ERROR
,
1562 "Unable to create pipes for notifier status - %s",
1567 NotifierStatusBuffer
= cupsdStatBufNew(NotifierPipes
[0], "[Notifier]");
1569 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
1570 "start_notifier: Adding fd %d to InputSet...",
1573 FD_SET(NotifierPipes
[0], InputSet
);
1576 if (cupsdOpenPipe(fds
))
1578 cupsdLogMessage(CUPSD_LOG_ERROR
,
1579 "Unable to create pipes for notifier %s - %s",
1580 scheme
, strerror(errno
));
1585 * Make sure the delivery pipe is non-blocking...
1588 fcntl(fds
[1], F_SETFL
, fcntl(fds
[1], F_GETFL
) | O_NONBLOCK
);
1591 * Create the notifier process...
1594 if (cupsdStartProcess(command
, argv
, envp
, fds
[0], -1, NotifierPipes
[1],
1598 * Error - can't fork!
1601 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to fork for notifier %s - %s",
1602 scheme
, strerror(errno
));
1604 cupsdClosePipe(fds
);
1609 * Fork successful - return the PID...
1612 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Notifier %s started - PID = %d",
1625 * End of "$Id: subscriptions.c 5878 2006-08-24 15:55:42Z mike $".