]>
Commit | Line | Data |
---|---|---|
ef416fc2 | 1 | /* |
61515785 | 2 | * "$Id: statbuf.c 10996 2013-05-29 11:51:34Z msweet $" |
ef416fc2 | 3 | * |
10d09e33 | 4 | * Status buffer routines for the CUPS scheduler. |
ef416fc2 | 5 | * |
a469f8a5 | 6 | * Copyright 2007-2012 by Apple Inc. |
e00b005a | 7 | * Copyright 1997-2006 by Easy Software Products, all rights reserved. |
ef416fc2 | 8 | * |
9 | * These coded instructions, statements, and computer programs are the | |
bc44d920 | 10 | * property of Apple Inc. and are protected by Federal copyright |
11 | * law. Distribution and use rights are outlined in the file "LICENSE.txt" | |
12 | * which should have been included with this file. If this file is | |
13 | * file is missing or damaged, see the license at "http://www.cups.org/". | |
ef416fc2 | 14 | * |
15 | * Contents: | |
16 | * | |
ef416fc2 | 17 | * cupsdStatBufDelete() - Destroy a status buffer. |
75bd9771 | 18 | * cupsdStatBufNew() - Create a new status buffer. |
ef416fc2 | 19 | * cupsdStatBufUpdate() - Update the status buffer. |
20 | */ | |
21 | ||
22 | /* | |
23 | * Include necessary headers... | |
24 | */ | |
25 | ||
26 | #include "cupsd.h" | |
27 | #include <stdarg.h> | |
28 | ||
29 | ||
75bd9771 MS |
30 | /* |
31 | * 'cupsdStatBufDelete()' - Destroy a status buffer. | |
32 | */ | |
33 | ||
34 | void | |
35 | cupsdStatBufDelete(cupsd_statbuf_t *sb) /* I - Status buffer */ | |
36 | { | |
37 | /* | |
38 | * Range check input... | |
39 | */ | |
40 | ||
41 | if (!sb) | |
42 | return; | |
43 | ||
44 | /* | |
45 | * Close the status pipe and free memory used... | |
46 | */ | |
47 | ||
48 | close(sb->fd); | |
49 | ||
50 | free(sb); | |
51 | } | |
52 | ||
53 | ||
ef416fc2 | 54 | /* |
55 | * 'cupsdStatBufNew()' - Create a new status buffer. | |
56 | */ | |
57 | ||
58 | cupsd_statbuf_t * /* O - New status buffer */ | |
b9faaae1 | 59 | cupsdStatBufNew(int fd, /* I - File descriptor of pipe */ |
ef416fc2 | 60 | const char *prefix, /* I - Printf-style prefix string */ |
61 | ...) /* I - Additional args as needed */ | |
62 | { | |
63 | cupsd_statbuf_t *sb; /* New status buffer */ | |
64 | va_list ap; /* Argument list */ | |
65 | ||
66 | ||
67 | /* | |
68 | * Range check input... | |
69 | */ | |
70 | ||
71 | if (fd < 0) | |
72 | return (NULL); | |
73 | ||
74 | /* | |
75 | * Allocate the status buffer... | |
76 | */ | |
77 | ||
78 | if ((sb = calloc(1, sizeof(cupsd_statbuf_t))) != NULL) | |
79 | { | |
80 | /* | |
81 | * Assign the file descriptor... | |
82 | */ | |
83 | ||
84 | sb->fd = fd; | |
85 | ||
86 | /* | |
87 | * Format the prefix string, if any. This is usually "[Job 123]" | |
88 | * or "[Sub 123]", and so forth. | |
89 | */ | |
90 | ||
91 | if (prefix) | |
92 | { | |
93 | /* | |
94 | * Printf-style prefix string... | |
95 | */ | |
96 | ||
97 | va_start(ap, prefix); | |
98 | vsnprintf(sb->prefix, sizeof(sb->prefix), prefix, ap); | |
99 | va_end(ap); | |
100 | } | |
101 | else | |
102 | { | |
103 | /* | |
104 | * No prefix string... | |
105 | */ | |
106 | ||
107 | sb->prefix[0] = '\0'; | |
108 | } | |
109 | } | |
110 | ||
111 | return (sb); | |
112 | } | |
113 | ||
114 | ||
ef416fc2 | 115 | /* |
116 | * 'cupsdStatBufUpdate()' - Update the status buffer. | |
117 | */ | |
118 | ||
119 | char * /* O - Line from buffer, "", or NULL */ | |
f0ab5bff MS |
120 | cupsdStatBufUpdate( |
121 | cupsd_statbuf_t *sb, /* I - Status buffer */ | |
a469f8a5 | 122 | int *loglevel, /* O - Log level */ |
f0ab5bff MS |
123 | char *line, /* I - Line buffer */ |
124 | int linelen) /* I - Size of line buffer */ | |
ef416fc2 | 125 | { |
126 | int bytes; /* Number of bytes read */ | |
127 | char *lineptr, /* Pointer to end of line in buffer */ | |
128 | *message; /* Pointer to message text */ | |
129 | ||
130 | ||
131 | /* | |
132 | * Check if the buffer already contains a full line... | |
133 | */ | |
134 | ||
135 | if ((lineptr = strchr(sb->buffer, '\n')) == NULL) | |
136 | { | |
137 | /* | |
138 | * No, read more data... | |
139 | */ | |
140 | ||
141 | if ((bytes = read(sb->fd, sb->buffer + sb->bufused, | |
142 | CUPSD_SB_BUFFER_SIZE - sb->bufused - 1)) > 0) | |
143 | { | |
144 | sb->bufused += bytes; | |
145 | sb->buffer[sb->bufused] = '\0'; | |
146 | ||
147 | /* | |
148 | * Guard against a line longer than the max buffer size... | |
149 | */ | |
150 | ||
151 | if ((lineptr = strchr(sb->buffer, '\n')) == NULL && | |
152 | sb->bufused == (CUPSD_SB_BUFFER_SIZE - 1)) | |
153 | lineptr = sb->buffer + sb->bufused; | |
154 | } | |
155 | else if (bytes < 0 && errno == EINTR) | |
156 | { | |
157 | /* | |
158 | * Return an empty line if we are interrupted... | |
159 | */ | |
160 | ||
161 | *loglevel = CUPSD_LOG_NONE; | |
162 | line[0] = '\0'; | |
163 | ||
164 | return (line); | |
165 | } | |
166 | else | |
167 | { | |
168 | /* | |
169 | * End-of-file, so use the whole buffer... | |
170 | */ | |
171 | ||
172 | lineptr = sb->buffer + sb->bufused; | |
173 | *lineptr = '\0'; | |
174 | } | |
175 | ||
176 | /* | |
177 | * Final check for end-of-file... | |
178 | */ | |
179 | ||
180 | if (sb->bufused == 0 && bytes == 0) | |
181 | lineptr = NULL; | |
182 | } | |
183 | ||
d09495fa | 184 | if (!lineptr) |
ef416fc2 | 185 | { |
186 | /* | |
187 | * End of file... | |
188 | */ | |
189 | ||
190 | *loglevel = CUPSD_LOG_NONE; | |
191 | line[0] = '\0'; | |
192 | ||
193 | return (NULL); | |
194 | } | |
195 | ||
196 | /* | |
197 | * Terminate the line and process it... | |
198 | */ | |
199 | ||
200 | *lineptr++ = '\0'; | |
201 | ||
202 | /* | |
203 | * Figure out the logging level... | |
204 | */ | |
205 | ||
206 | if (!strncmp(sb->buffer, "EMERG:", 6)) | |
207 | { | |
208 | *loglevel = CUPSD_LOG_EMERG; | |
209 | message = sb->buffer + 6; | |
210 | } | |
211 | else if (!strncmp(sb->buffer, "ALERT:", 6)) | |
212 | { | |
213 | *loglevel = CUPSD_LOG_ALERT; | |
214 | message = sb->buffer + 6; | |
215 | } | |
216 | else if (!strncmp(sb->buffer, "CRIT:", 5)) | |
217 | { | |
218 | *loglevel = CUPSD_LOG_CRIT; | |
219 | message = sb->buffer + 5; | |
220 | } | |
221 | else if (!strncmp(sb->buffer, "ERROR:", 6)) | |
222 | { | |
223 | *loglevel = CUPSD_LOG_ERROR; | |
224 | message = sb->buffer + 6; | |
225 | } | |
226 | else if (!strncmp(sb->buffer, "WARNING:", 8)) | |
227 | { | |
228 | *loglevel = CUPSD_LOG_WARN; | |
229 | message = sb->buffer + 8; | |
230 | } | |
231 | else if (!strncmp(sb->buffer, "NOTICE:", 7)) | |
232 | { | |
233 | *loglevel = CUPSD_LOG_NOTICE; | |
234 | message = sb->buffer + 7; | |
235 | } | |
236 | else if (!strncmp(sb->buffer, "INFO:", 5)) | |
237 | { | |
238 | *loglevel = CUPSD_LOG_INFO; | |
239 | message = sb->buffer + 5; | |
240 | } | |
241 | else if (!strncmp(sb->buffer, "DEBUG:", 6)) | |
242 | { | |
243 | *loglevel = CUPSD_LOG_DEBUG; | |
244 | message = sb->buffer + 6; | |
245 | } | |
246 | else if (!strncmp(sb->buffer, "DEBUG2:", 7)) | |
247 | { | |
248 | *loglevel = CUPSD_LOG_DEBUG2; | |
249 | message = sb->buffer + 7; | |
250 | } | |
251 | else if (!strncmp(sb->buffer, "PAGE:", 5)) | |
252 | { | |
253 | *loglevel = CUPSD_LOG_PAGE; | |
254 | message = sb->buffer + 5; | |
255 | } | |
256 | else if (!strncmp(sb->buffer, "STATE:", 6)) | |
257 | { | |
258 | *loglevel = CUPSD_LOG_STATE; | |
259 | message = sb->buffer + 6; | |
260 | } | |
a469f8a5 MS |
261 | else if (!strncmp(sb->buffer, "JOBSTATE:", 9)) |
262 | { | |
263 | *loglevel = CUPSD_LOG_JOBSTATE; | |
264 | message = sb->buffer + 9; | |
265 | } | |
ef416fc2 | 266 | else if (!strncmp(sb->buffer, "ATTR:", 5)) |
267 | { | |
268 | *loglevel = CUPSD_LOG_ATTR; | |
269 | message = sb->buffer + 5; | |
270 | } | |
c9fc04c6 MS |
271 | else if (!strncmp(sb->buffer, "PPD:", 4)) |
272 | { | |
273 | *loglevel = CUPSD_LOG_PPD; | |
274 | message = sb->buffer + 4; | |
275 | } | |
ef416fc2 | 276 | else |
277 | { | |
89d46774 | 278 | *loglevel = CUPSD_LOG_DEBUG; |
ef416fc2 | 279 | message = sb->buffer; |
280 | } | |
281 | ||
282 | /* | |
283 | * Skip leading whitespace in the message... | |
284 | */ | |
285 | ||
286 | while (isspace(*message & 255)) | |
287 | message ++; | |
288 | ||
289 | /* | |
290 | * Send it to the log file as needed... | |
291 | */ | |
292 | ||
75bd9771 | 293 | if (sb->prefix[0]) |
ef416fc2 | 294 | { |
75bd9771 | 295 | if (*loglevel > CUPSD_LOG_NONE && |
94da7e34 | 296 | (*loglevel != CUPSD_LOG_INFO || LogLevel >= CUPSD_LOG_DEBUG)) |
75bd9771 MS |
297 | { |
298 | /* | |
299 | * General status message; send it to the error_log file... | |
300 | */ | |
ef416fc2 | 301 | |
75bd9771 MS |
302 | if (message[0] == '[') |
303 | cupsdLogMessage(*loglevel, "%s", message); | |
304 | else | |
305 | cupsdLogMessage(*loglevel, "%s %s", sb->prefix, message); | |
306 | } | |
94da7e34 | 307 | else if (*loglevel < CUPSD_LOG_NONE && LogLevel >= CUPSD_LOG_DEBUG) |
75bd9771 | 308 | cupsdLogMessage(CUPSD_LOG_DEBUG2, "%s %s", sb->prefix, sb->buffer); |
ef416fc2 | 309 | } |
310 | ||
311 | /* | |
312 | * Copy the message to the line buffer... | |
313 | */ | |
314 | ||
315 | strlcpy(line, message, linelen); | |
316 | ||
317 | /* | |
318 | * Copy over the buffer data we've used up... | |
319 | */ | |
320 | ||
e53920b9 | 321 | if (lineptr < sb->buffer + sb->bufused) |
322 | _cups_strcpy(sb->buffer, lineptr); | |
323 | ||
ef416fc2 | 324 | sb->bufused -= lineptr - sb->buffer; |
325 | ||
326 | if (sb->bufused < 0) | |
327 | sb->bufused = 0; | |
328 | ||
329 | return (line); | |
330 | } | |
331 | ||
332 | ||
333 | /* | |
61515785 | 334 | * End of "$Id: statbuf.c 10996 2013-05-29 11:51:34Z msweet $". |
ef416fc2 | 335 | */ |