2 * "$Id: request.c 7946 2008-09-16 23:27:54Z mike $"
4 * IPP utilities for the Common UNIX Printing System (CUPS).
6 * Copyright 2007-2010 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products.
9 * These coded instructions, statements, and computer programs are the
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/".
15 * This file is subject to the Apple OS-Developed Software exception.
19 * cupsDoFileRequest() - Do an IPP request with a file.
20 * cupsDoIORequest() - Do an IPP request with file descriptors.
21 * cupsDoRequest() - Do an IPP request.
22 * cupsGetResponse() - Get a response to an IPP request.
23 * cupsReadResponseData() - Read additional data after the IPP response.
24 * cupsSendRequest() - Send an IPP request.
25 * cupsWriteRequestData() - Write additional data after an IPP request.
26 * _cupsSetError() - Set the last IPP status code and status-message.
27 * _cupsSetHTTPError() - Set the last error using the HTTP status.
31 * Include necessary headers...
40 #if defined(WIN32) || defined(__EMX__)
44 #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 @link ippDelete@
55 * after receiving a valid IPP response.
58 ipp_t
* /* O - Response data */
59 cupsDoFileRequest(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
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 @code NULL@ for none */
64 ipp_t
*response
; /* IPP response data */
65 int infile
; /* Input file */
68 DEBUG_printf(("cupsDoFileRequest(http=%p, request=%p(%s), resource=\"%s\", "
69 "filename=\"%s\")", http
, request
,
70 request
? ippOpString(request
->request
.op
.operation_id
) : "?",
75 if ((infile
= open(filename
, O_RDONLY
| O_BINARY
)) < 0)
78 * Can't get file information!
81 _cupsSetError(errno
== ENOENT
? IPP_NOT_FOUND
: IPP_NOT_AUTHORIZED
,
92 response
= cupsDoIORequest(http
, request
, resource
, infile
, -1);
102 * 'cupsDoIORequest()' - Do an IPP request with file descriptors.
104 * This function sends the IPP request to the specified server, retrying
105 * and authenticating as necessary. The request is freed with ippDelete()
106 * after receiving a valid IPP response.
108 * If "infile" is a valid file descriptor, cupsDoIORequest() copies
109 * all of the data from the file after the IPP request message.
111 * If "outfile" is a valid file descriptor, cupsDoIORequest() copies
112 * all of the data after the IPP response message to the file.
114 * @since CUPS 1.3/Mac OS X 10.5@
117 ipp_t
* /* O - Response data */
118 cupsDoIORequest(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
119 ipp_t
*request
, /* I - IPP request */
120 const char *resource
, /* I - HTTP resource for POST */
121 int infile
, /* I - File to read from or -1 for none */
122 int outfile
) /* I - File to write to or -1 for none */
124 ipp_t
*response
= NULL
; /* IPP response data */
125 size_t length
= 0; /* Content-Length value */
126 http_status_t status
; /* Status of HTTP request */
127 struct stat fileinfo
; /* File information */
128 int bytes
; /* Number of bytes read/written */
129 char buffer
[32768]; /* Output buffer */
132 DEBUG_printf(("cupsDoIORequest(http=%p, request=%p(%s), resource=\"%s\", "
133 "infile=%d, outfile=%d)", http
, request
,
134 request
? ippOpString(request
->request
.op
.operation_id
) : "?",
135 resource
, infile
, outfile
));
138 * Range check input...
141 if (!request
|| !resource
)
145 _cupsSetError(IPP_INTERNAL_ERROR
, strerror(EINVAL
), 0);
151 * Get the default connection as needed...
155 if ((http
= _cupsConnect()) == NULL
)
159 * See if we have a file to send...
164 if (fstat(infile
, &fileinfo
))
167 * Can't get file information!
170 _cupsSetError(errno
== EBADF
? IPP_NOT_FOUND
: IPP_NOT_AUTHORIZED
,
179 if (fileinfo
.st_mode
& _S_IFDIR
)
181 if (S_ISDIR(fileinfo
.st_mode
))
185 * Can't send a directory...
190 _cupsSetError(IPP_NOT_POSSIBLE
, strerror(EISDIR
), 0);
196 if (!S_ISREG(fileinfo
.st_mode
))
197 length
= 0; /* Chunk when piping */
200 length
= ippLength(request
) + fileinfo
.st_size
;
203 length
= ippLength(request
);
205 DEBUG_printf(("2cupsDoIORequest: Request length=%ld, total length=%ld",
206 (long)ippLength(request
), (long)length
));
209 * Clear any "Local" authentication data since it is probably stale...
212 if (http
->authstring
&& !strncmp(http
->authstring
, "Local ", 6))
213 httpSetAuthString(http
, NULL
, NULL
);
216 * Loop until we can send the request without authorization problems.
219 while (response
== NULL
)
221 DEBUG_puts("2cupsDoIORequest: setup...");
224 * Send the request...
227 status
= cupsSendRequest(http
, request
, resource
, length
);
229 DEBUG_printf(("2cupsDoIORequest: status=%d", status
));
231 if (status
== HTTP_CONTINUE
&& request
->state
== IPP_DATA
&& infile
>= 0)
233 DEBUG_puts("2cupsDoIORequest: file write...");
236 * Send the file with the request...
240 if (S_ISREG(fileinfo
.st_mode
))
242 lseek(infile
, 0, SEEK_SET
);
244 while ((bytes
= (int)read(infile
, buffer
, sizeof(buffer
))) > 0)
248 if ((status
= httpUpdate(http
)) != HTTP_CONTINUE
)
252 if (httpWrite2(http
, buffer
, bytes
) < bytes
)
258 * Get the server's response...
261 if (status
== HTTP_CONTINUE
|| status
== HTTP_OK
)
263 response
= cupsGetResponse(http
, resource
);
264 status
= http
->status
;
269 DEBUG_printf(("2cupsDoIORequest: status=%d", status
));
271 if (status
== HTTP_ERROR
||
272 (status
>= HTTP_BAD_REQUEST
&& status
!= HTTP_UNAUTHORIZED
&&
273 status
!= HTTP_UPGRADE_REQUIRED
))
275 _cupsSetHTTPError(status
);
284 * Write trailing data to file...
287 while ((bytes
= (int)httpRead2(http
, buffer
, sizeof(buffer
))) > 0)
288 if (write(outfile
, buffer
, bytes
) < bytes
)
294 * Flush any remaining data...
303 * Delete the original request and return the response...
313 * 'cupsDoRequest()' - Do an IPP request.
315 * This function sends the IPP request to the specified server, retrying
316 * and authenticating as necessary. The request is freed with ippDelete()
317 * after receiving a valid IPP response.
320 ipp_t
* /* O - Response data */
321 cupsDoRequest(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
322 ipp_t
*request
, /* I - IPP request */
323 const char *resource
) /* I - HTTP resource for POST */
325 DEBUG_printf(("cupsDoRequest(http=%p, request=%p(%s), resource=\"%s\")",
327 request
? ippOpString(request
->request
.op
.operation_id
) : "?",
330 return (cupsDoIORequest(http
, request
, resource
, -1, -1));
335 * 'cupsGetResponse()' - Get a response to an IPP request.
337 * Use this function to get the response for an IPP request sent using
338 * cupsSendDocument() or cupsSendRequest(). For requests that return
339 * additional data, use httpRead() after getting a successful response.
341 * @since CUPS 1.4/Mac OS X 10.6@
344 ipp_t
* /* O - Response or @code NULL@ on HTTP error */
345 cupsGetResponse(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
346 const char *resource
) /* I - HTTP resource for POST */
348 http_status_t status
; /* HTTP status */
349 ipp_state_t state
; /* IPP read state */
350 ipp_t
*response
= NULL
; /* IPP response */
353 DEBUG_printf(("cupsGetResponse(http=%p, resource=\"%s\")", http
, resource
));
356 * Connect to the default server as needed...
360 http
= _cupsConnect();
362 if (!http
|| (http
->state
!= HTTP_POST_RECV
&& http
->state
!= HTTP_POST_SEND
))
366 * Check for an unfinished chunked request...
369 if (http
->data_encoding
== HTTP_ENCODE_CHUNKED
)
372 * Send a 0-length chunk to finish off the request...
375 DEBUG_puts("2cupsGetResponse: Finishing chunked POST...");
377 if (httpWrite2(http
, "", 0) < 0)
382 * Wait for a response from the server...
385 DEBUG_printf(("2cupsGetResponse: Update loop, http->status=%d...",
388 status
= http
->status
;
389 while (status
== HTTP_CONTINUE
)
390 status
= httpUpdate(http
);
392 DEBUG_printf(("2cupsGetResponse: status=%d", status
));
394 if (status
== HTTP_OK
)
397 * Get the IPP response...
402 while ((state
= ippRead(http
, response
)) != IPP_DATA
)
403 if (state
== IPP_ERROR
)
406 if (state
== IPP_ERROR
)
409 * Delete the response...
412 DEBUG_puts("1cupsGetResponse: IPP read error!");
417 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
420 else if (status
!= HTTP_ERROR
)
423 * Flush any error message...
429 * Then handle encryption and authentication...
432 if (status
== HTTP_UNAUTHORIZED
)
435 * See if we can do authentication...
438 DEBUG_puts("2cupsGetResponse: Need authorization...");
440 if (!cupsDoAuthentication(http
, "POST", resource
))
443 status
= HTTP_AUTHORIZATION_CANCELED
;
447 else if (status
== HTTP_UPGRADE_REQUIRED
)
450 * Force a reconnect with encryption...
453 DEBUG_puts("2cupsGetResponse: Need encryption...");
455 if (!httpReconnect(http
))
456 httpEncryption(http
, HTTP_ENCRYPT_REQUIRED
);
458 #endif /* HAVE_SSL */
463 ipp_attribute_t
*attr
; /* status-message attribute */
466 attr
= ippFindAttribute(response
, "status-message", IPP_TAG_TEXT
);
468 DEBUG_printf(("1cupsGetResponse: status-code=%s, status-message=\"%s\"",
469 ippErrorString(response
->request
.status
.status_code
),
470 attr
? attr
->values
[0].string
.text
: ""));
472 _cupsSetError(response
->request
.status
.status_code
,
473 attr
? attr
->values
[0].string
.text
:
474 ippErrorString(response
->request
.status
.status_code
), 0);
476 else if (status
!= HTTP_OK
)
477 _cupsSetHTTPError(status
);
484 * 'cupsReadResponseData()' - Read additional data after the IPP response.
486 * This function is used after cupsGetResponse() to read the PPD or document
487 * files for CUPS_GET_PPD and CUPS_GET_DOCUMENT requests, respectively.
489 * @since CUPS 1.4/Mac OS X 10.6@
492 ssize_t
/* O - Bytes read, 0 on EOF, -1 on error */
493 cupsReadResponseData(
494 http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
495 char *buffer
, /* I - Buffer to use */
496 size_t length
) /* I - Number of bytes to read */
499 * Get the default connection as needed...
502 DEBUG_printf(("cupsReadResponseData(http=%p, buffer=%p, "
503 "length=" CUPS_LLFMT
")", http
, buffer
, CUPS_LLCAST length
));
507 _cups_globals_t
*cg
= _cupsGlobals();
508 /* Pointer to library globals */
510 if ((http
= cg
->http
) == NULL
)
512 _cupsSetError(IPP_INTERNAL_ERROR
, _("No active connection"), 1);
518 * Then read from the HTTP connection...
521 return (httpRead2(http
, buffer
, length
));
526 * 'cupsSendRequest()' - Send an IPP request.
528 * Use httpWrite() to write any additional data (document, PPD file, etc.)
529 * for the request, cupsGetResponse() to get the IPP response, and httpRead()
530 * to read any additional data following the response. Only one request can be
531 * sent/queued at a time.
533 * Unlike cupsDoFileRequest(), cupsDoIORequest(), and cupsDoRequest(), the
534 * request is not freed.
536 * @since CUPS 1.4/Mac OS X 10.6@
539 http_status_t
/* O - Initial HTTP status */
540 cupsSendRequest(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
541 ipp_t
*request
, /* I - IPP request */
542 const char *resource
, /* I - Resource path */
543 size_t length
) /* I - Length of data to follow or @code CUPS_LENGTH_VARIABLE@ */
545 http_status_t status
; /* Status of HTTP request */
546 int got_status
; /* Did we get the status? */
547 ipp_state_t state
; /* State of IPP processing */
548 http_status_t expect
; /* Expect: header to use */
551 DEBUG_printf(("cupsSendRequest(http=%p, request=%p(%s), resource=\"%s\", "
552 "length=" CUPS_LLFMT
")", http
, request
,
553 request
? ippOpString(request
->request
.op
.operation_id
) : "?",
554 resource
, CUPS_LLCAST length
));
557 * Range check input...
560 if (!request
|| !resource
)
562 _cupsSetError(IPP_INTERNAL_ERROR
, strerror(EINVAL
), 0);
568 * Get the default connection as needed...
572 if ((http
= _cupsConnect()) == NULL
)
573 return (HTTP_SERVICE_UNAVAILABLE
);
577 * See if we have an auth-info attribute and are communicating over
578 * a non-local link. If so, encrypt the link so that we can pass
579 * the authentication information securely...
582 if (ippFindAttribute(request
, "auth-info", IPP_TAG_TEXT
) &&
583 !httpAddrLocalhost(http
->hostaddr
) && !http
->tls
&&
584 httpEncryption(http
, HTTP_ENCRYPT_REQUIRED
))
586 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
587 return (HTTP_SERVICE_UNAVAILABLE
);
589 #endif /* HAVE_SSL */
592 * Reconnect if the last response had a "Connection: close"...
595 if (!strcasecmp(http
->fields
[HTTP_FIELD_CONNECTION
], "close"))
596 if (httpReconnect(http
))
598 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
599 return (HTTP_SERVICE_UNAVAILABLE
);
603 * Loop until we can send the request without authorization problems.
606 expect
= HTTP_CONTINUE
;
610 DEBUG_puts("2cupsSendRequest: Setup...");
613 * Setup the HTTP variables needed...
616 httpClearFields(http
);
617 httpSetLength(http
, length
);
618 httpSetField(http
, HTTP_FIELD_CONTENT_TYPE
, "application/ipp");
619 httpSetField(http
, HTTP_FIELD_AUTHORIZATION
, http
->authstring
);
620 httpSetExpect(http
, expect
);
622 DEBUG_printf(("2cupsSendRequest: authstring=\"%s\"", http
->authstring
));
628 DEBUG_puts("2cupsSendRequest: Sending HTTP POST...");
630 if (httpPost(http
, resource
))
632 if (httpReconnect(http
))
634 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
635 return (HTTP_SERVICE_UNAVAILABLE
);
642 * Send the IPP data...
645 DEBUG_puts("2cupsSendRequest: Writing IPP request...");
647 request
->state
= IPP_IDLE
;
648 status
= HTTP_CONTINUE
;
651 while ((state
= ippWrite(http
, request
)) != IPP_DATA
)
652 if (state
== IPP_ERROR
)
654 else if (httpCheck(http
))
658 if ((status
= httpUpdate(http
)) != HTTP_CONTINUE
)
663 * Wait up to 1 second to get the 100-continue response as needed...
666 if (!got_status
&& expect
== HTTP_CONTINUE
)
668 DEBUG_puts("2cupsSendRequest: Waiting for 100-continue...");
670 if (httpWait(http
, 1000))
671 status
= httpUpdate(http
);
673 else if (httpCheck(http
))
674 status
= httpUpdate(http
);
676 DEBUG_printf(("2cupsSendRequest: status=%d", status
));
679 * Process the current HTTP status...
689 case HTTP_UNAUTHORIZED
:
690 if (!cupsDoAuthentication(http
, "POST", resource
))
692 if (httpReconnect(http
))
694 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
695 return (HTTP_SERVICE_UNAVAILABLE
);
699 status
= HTTP_AUTHORIZATION_CANCELED
;
704 case HTTP_UPGRADE_REQUIRED
:
706 * Flush any error message, reconnect, and then upgrade with
710 if (httpReconnect(http
))
712 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
713 return (HTTP_SERVICE_UNAVAILABLE
);
716 httpEncryption(http
, HTTP_ENCRYPT_REQUIRED
);
719 #endif /* HAVE_SSL */
721 case HTTP_EXPECTATION_FAILED
:
723 * Don't try using the Expect: header the next time around...
726 expect
= (http_status_t
)0;
728 if (httpReconnect(http
))
730 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
731 return (HTTP_SERVICE_UNAVAILABLE
);
737 * Some other error...
747 * 'cupsWriteRequestData()' - Write additional data after an IPP request.
749 * This function is used after @link cupsSendRequest@ to provide a PPD and
750 * after @link cupsStartDocument@ to provide a document file.
752 * @since CUPS 1.4/Mac OS X 10.6@
755 http_status_t
/* O - @code HTTP_CONTINUE@ if OK or HTTP status on error */
756 cupsWriteRequestData(
757 http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
758 const char *buffer
, /* I - Bytes to write */
759 size_t length
) /* I - Number of bytes to write */
761 int wused
; /* Previous bytes in buffer */
765 * Get the default connection as needed...
768 DEBUG_printf(("cupsWriteRequestData(http=%p, buffer=%p, "
769 "length=" CUPS_LLFMT
")", http
, buffer
, CUPS_LLCAST length
));
773 _cups_globals_t
*cg
= _cupsGlobals();
774 /* Pointer to library globals */
776 if ((http
= cg
->http
) == NULL
)
778 _cupsSetError(IPP_INTERNAL_ERROR
, _("No active connection"), 1);
784 * Then write to the HTTP connection...
789 if (httpWrite2(http
, buffer
, length
) < 0)
793 * Finally, check if we have any pending data from the server...
796 if (length
>= HTTP_MAX_BUFFER
||
797 http
->wused
< wused
||
798 (wused
> 0 && http
->wused
== length
))
801 * We've written something to the server, so check for response data...
804 if (_httpWait(http
, 0, 1))
805 return (httpUpdate(http
));
808 return (HTTP_CONTINUE
);
813 * '_cupsSetError()' - Set the last IPP status code and status-message.
817 _cupsSetError(ipp_status_t status
, /* I - IPP status code */
818 const char *message
, /* I - status-message value */
819 int localize
) /* I - Localize the message? */
821 _cups_globals_t
*cg
; /* Global data */
824 if (!message
&& errno
)
826 message
= strerror(errno
);
831 cg
->last_error
= status
;
833 if (cg
->last_status_message
)
835 _cupsStrFree(cg
->last_status_message
);
837 cg
->last_status_message
= NULL
;
845 * Get the message catalog...
848 if (!cg
->lang_default
)
849 cg
->lang_default
= cupsLangDefault();
851 cg
->last_status_message
= _cupsStrAlloc(_cupsLangString(cg
->lang_default
,
855 cg
->last_status_message
= _cupsStrAlloc(message
);
858 DEBUG_printf(("4_cupsSetError: last_error=%s, last_status_message=\"%s\"",
859 ippErrorString(cg
->last_error
), cg
->last_status_message
));
864 * '_cupsSetHTTPError()' - Set the last error using the HTTP status.
868 _cupsSetHTTPError(http_status_t status
) /* I - HTTP status code */
872 case HTTP_NOT_FOUND
:
873 _cupsSetError(IPP_NOT_FOUND
, httpStatus(status
), 0);
876 case HTTP_UNAUTHORIZED
:
877 case HTTP_AUTHORIZATION_CANCELED
:
878 _cupsSetError(IPP_NOT_AUTHORIZED
, httpStatus(status
), 0);
881 case HTTP_FORBIDDEN
:
882 _cupsSetError(IPP_FORBIDDEN
, httpStatus(status
), 0);
885 case HTTP_BAD_REQUEST
:
886 _cupsSetError(IPP_BAD_REQUEST
, httpStatus(status
), 0);
889 case HTTP_REQUEST_TOO_LARGE
:
890 _cupsSetError(IPP_REQUEST_VALUE
, httpStatus(status
), 0);
893 case HTTP_NOT_IMPLEMENTED
:
894 _cupsSetError(IPP_OPERATION_NOT_SUPPORTED
, httpStatus(status
), 0);
897 case HTTP_NOT_SUPPORTED
:
898 _cupsSetError(IPP_VERSION_NOT_SUPPORTED
, httpStatus(status
), 0);
902 DEBUG_printf(("4_cupsSetHTTPError: HTTP error %d mapped to "
903 "IPP_SERVICE_UNAVAILABLE!", status
));
904 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, httpStatus(status
), 0);
911 * End of "$Id: request.c 7946 2008-09-16 23:27:54Z mike $".