2 * "$Id: request.c 6253 2007-02-10 18:48:40Z mike $"
4 * IPP utilities for the Common UNIX Printing System (CUPS).
6 * Copyright 1997-2007 by Easy Software Products.
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
24 * This file is subject to the Apple OS-Developed Software exception.
28 * cupsDoFileRequest() - Do an IPP request with a file.
29 * cupsDoRequest() - Do an IPP request.
30 * _cupsSetError() - Set the last IPP status code and status-message.
34 * Include necessary headers...
43 #if defined(WIN32) || defined(__EMX__)
47 #endif /* WIN32 || __EMX__ */
51 * 'cupsDoFileRequest()' - Do an IPP request with a file.
53 * This function sends the IPP request to the specified server, retrying
54 * and authenticating as necessary. The request is freed with ippDelete()
55 * after receiving a valid IPP response.
58 ipp_t
* /* O - Response data */
59 cupsDoFileRequest(http_t
*http
, /* I - HTTP connection to server */
60 ipp_t
*request
, /* I - IPP request */
61 const char *resource
, /* I - HTTP resource for POST */
62 const char *filename
) /* I - File to send or NULL for none */
64 ipp_t
*response
; /* IPP response data */
65 size_t length
; /* Content-Length value */
66 http_status_t status
; /* Status of HTTP request */
67 int got_status
; /* Did we get the status? */
68 ipp_state_t state
; /* State of IPP processing */
69 FILE *file
; /* File to send */
70 struct stat fileinfo
; /* File information */
71 int bytes
; /* Number of bytes read/written */
72 char buffer
[32768]; /* Output buffer */
73 http_status_t expect
; /* Expect: header to use */
74 #ifdef HAVE_AUTHORIZATION_H
75 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
76 #endif /* HAVE_AUTHORIZATION_H */
79 DEBUG_printf(("cupsDoFileRequest(%p, %p, \'%s\', \'%s\')\n",
80 http
, request
, resource
? resource
: "(null)",
81 filename
? filename
: "(null)"));
83 if (http
== NULL
|| request
== NULL
|| resource
== NULL
)
88 _cupsSetError(IPP_INTERNAL_ERROR
, NULL
);
94 * See if we have a file to send...
99 if (stat(filename
, &fileinfo
))
102 * Can't get file information!
105 _cupsSetError(errno
== ENOENT
? IPP_NOT_FOUND
: IPP_NOT_AUTHORIZED
,
114 if (fileinfo
.st_mode
& _S_IFDIR
)
116 if (S_ISDIR(fileinfo
.st_mode
))
120 * Can't send a directory...
125 _cupsSetError(IPP_NOT_POSSIBLE
, strerror(EISDIR
));
130 if ((file
= fopen(filename
, "rb")) == NULL
)
136 _cupsSetError(errno
== ENOENT
? IPP_NOT_FOUND
: IPP_NOT_AUTHORIZED
,
148 * Loop until we can send the request without authorization problems.
153 expect
= HTTP_CONTINUE
;
155 while (response
== NULL
)
157 DEBUG_puts("cupsDoFileRequest: setup...");
160 * Setup the HTTP variables needed...
163 length
= ippLength(request
);
165 length
+= fileinfo
.st_size
;
167 httpClearFields(http
);
168 httpSetLength(http
, length
);
169 httpSetField(http
, HTTP_FIELD_CONTENT_TYPE
, "application/ipp");
170 httpSetField(http
, HTTP_FIELD_AUTHORIZATION
, http
->authstring
);
171 httpSetExpect(http
, expect
);
173 DEBUG_printf(("cupsDoFileRequest: authstring=\"%s\"\n", http
->authstring
));
179 DEBUG_puts("cupsDoFileRequest: post...");
181 if (httpPost(http
, resource
))
183 if (httpReconnect(http
))
193 * Send the IPP data...
196 DEBUG_puts("cupsDoFileRequest: ipp write...");
198 request
->state
= IPP_IDLE
;
199 status
= HTTP_CONTINUE
;
202 while ((state
= ippWrite(http
, request
)) != IPP_DATA
)
203 if (state
== IPP_ERROR
)
205 else if (httpCheck(http
))
209 if ((status
= httpUpdate(http
)) != HTTP_CONTINUE
)
216 * Wait up to 1 second to get the 100-continue response...
219 if (httpWait(http
, 1000))
220 status
= httpUpdate(http
);
222 else if (httpCheck(http
))
223 status
= httpUpdate(http
);
225 if (status
== HTTP_CONTINUE
&& state
== IPP_DATA
&& filename
)
227 DEBUG_puts("cupsDoFileRequest: file write...");
235 while ((bytes
= (int)fread(buffer
, 1, sizeof(buffer
), file
)) > 0)
239 if ((status
= httpUpdate(http
)) != HTTP_CONTINUE
)
243 if (httpWrite2(http
, buffer
, bytes
) < bytes
)
249 * Get the server's return status...
252 DEBUG_puts("cupsDoFileRequest: update...");
254 while (status
== HTTP_CONTINUE
)
255 status
= httpUpdate(http
);
257 DEBUG_printf(("cupsDoFileRequest: status = %d\n", status
));
259 if (status
== HTTP_UNAUTHORIZED
)
261 DEBUG_puts("cupsDoFileRequest: unauthorized...");
264 * Flush any error message...
270 * See if we can do authentication...
273 if (cupsDoAuthentication(http
, "POST", resource
))
276 if (httpReconnect(http
))
284 else if (status
== HTTP_ERROR
)
286 DEBUG_printf(("cupsDoFileRequest: http->error=%d (%s)\n", http
->error
,
287 strerror(http
->error
)));
290 if (http
->error
!= WSAENETDOWN
&& http
->error
!= WSAENETUNREACH
&&
291 http
->error
!= WSAETIMEDOUT
)
293 if (http
->error
!= ENETDOWN
&& http
->error
!= ENETUNREACH
&&
294 http
->error
!= ETIMEDOUT
)
301 else if (status
== HTTP_UPGRADE_REQUIRED
)
303 /* Flush any error message... */
307 if (httpReconnect(http
))
313 /* Upgrade with encryption... */
314 httpEncryption(http
, HTTP_ENCRYPT_REQUIRED
);
316 /* Try again, this time with encryption enabled... */
319 #endif /* HAVE_SSL */
320 else if (status
== HTTP_EXPECTATION_FAILED
)
323 * Don't try using the Expect: header the next time around...
326 expect
= (http_status_t
)0;
328 else if (status
!= HTTP_OK
)
330 DEBUG_printf(("cupsDoFileRequest: error %d...\n", status
));
333 * Flush any error message...
342 * Read the response...
345 DEBUG_puts("cupsDoFileRequest: response...");
349 while ((state
= ippRead(http
, response
)) != IPP_DATA
)
350 if (state
== IPP_ERROR
)
353 * Delete the response...
356 DEBUG_puts("IPP read error!");
360 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, strerror(errno
));
368 * Close the file if needed...
371 if (filename
!= NULL
)
375 * Flush any remaining data...
381 * Delete the original request and return the response...
388 ipp_attribute_t
*attr
; /* status-message attribute */
391 attr
= ippFindAttribute(response
, "status-message", IPP_TAG_TEXT
);
393 _cupsSetError(response
->request
.status
.status_code
,
394 attr
? attr
->values
[0].string
.text
:
395 ippErrorString(response
->request
.status
.status_code
));
397 else if (status
!= HTTP_OK
)
401 case HTTP_NOT_FOUND
:
402 _cupsSetError(IPP_NOT_FOUND
, httpStatus(status
));
405 case HTTP_UNAUTHORIZED
:
406 _cupsSetError(IPP_NOT_AUTHORIZED
, httpStatus(status
));
409 case HTTP_FORBIDDEN
:
410 _cupsSetError(IPP_FORBIDDEN
, httpStatus(status
));
413 case HTTP_BAD_REQUEST
:
414 _cupsSetError(IPP_BAD_REQUEST
, httpStatus(status
));
417 case HTTP_REQUEST_TOO_LARGE
:
418 _cupsSetError(IPP_REQUEST_VALUE
, httpStatus(status
));
421 case HTTP_NOT_IMPLEMENTED
:
422 _cupsSetError(IPP_OPERATION_NOT_SUPPORTED
, httpStatus(status
));
425 case HTTP_NOT_SUPPORTED
:
426 _cupsSetError(IPP_VERSION_NOT_SUPPORTED
, httpStatus(status
));
430 DEBUG_printf(("HTTP error %d mapped to IPP_SERVICE_UNAVAILABLE!\n",
432 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, httpStatus(status
));
437 #ifdef HAVE_AUTHORIZATION_H
439 * Delete any authorization reference created for this request...
444 AuthorizationFree(cg
->auth_ref
, kAuthorizationFlagDefaults
);
447 #endif /* HAVE_AUTHORIZATION_H */
454 * 'cupsDoRequest()' - Do an IPP request.
456 * This function sends the IPP request to the specified server, retrying
457 * and authenticating as necessary. The request is freed with ippDelete()
458 * after receiving a valid IPP response.
461 ipp_t
* /* O - Response data */
462 cupsDoRequest(http_t
*http
, /* I - HTTP connection to server */
463 ipp_t
*request
, /* I - IPP request */
464 const char *resource
) /* I - HTTP resource for POST */
466 return (cupsDoFileRequest(http
, request
, resource
, NULL
));
471 * '_cupsSetError()' - Set the last IPP status code and status-message.
475 _cupsSetError(ipp_status_t status
, /* I - IPP status code */
476 const char *message
) /* I - status-message value */
478 _cups_globals_t
*cg
; /* Global data */
482 cg
->last_error
= status
;
484 if (cg
->last_status_message
)
486 free(cg
->last_status_message
);
488 cg
->last_status_message
= NULL
;
492 cg
->last_status_message
= strdup(message
);
497 * End of "$Id: request.c 6253 2007-02-10 18:48:40Z mike $".