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-2009 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
;
267 if (status
== HTTP_FORBIDDEN
|| status
== HTTP_ERROR
||
268 status
>= HTTP_SERVER_ERROR
)
270 _cupsSetHTTPError(status
);
279 * Write trailing data to file...
282 while ((bytes
= (int)httpRead2(http
, buffer
, sizeof(buffer
))) > 0)
283 if (write(outfile
, buffer
, bytes
) < bytes
)
289 * Flush any remaining data...
298 * Delete the original request and return the response...
308 * 'cupsDoRequest()' - Do an IPP request.
310 * This function sends the IPP request to the specified server, retrying
311 * and authenticating as necessary. The request is freed with ippDelete()
312 * after receiving a valid IPP response.
315 ipp_t
* /* O - Response data */
316 cupsDoRequest(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
317 ipp_t
*request
, /* I - IPP request */
318 const char *resource
) /* I - HTTP resource for POST */
320 DEBUG_printf(("cupsDoRequest(http=%p, request=%p(%s), resource=\"%s\")",
322 request
? ippOpString(request
->request
.op
.operation_id
) : "?",
325 return (cupsDoIORequest(http
, request
, resource
, -1, -1));
330 * 'cupsGetResponse()' - Get a response to an IPP request.
332 * Use this function to get the response for an IPP request sent using
333 * cupsSendDocument() or cupsSendRequest(). For requests that return
334 * additional data, use httpRead() after getting a successful response.
339 ipp_t
* /* O - Response or @code NULL@ on HTTP error */
340 cupsGetResponse(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
341 const char *resource
) /* I - HTTP resource for POST */
343 http_status_t status
; /* HTTP status */
344 ipp_state_t state
; /* IPP read state */
345 ipp_t
*response
= NULL
; /* IPP response */
348 DEBUG_printf(("cupsGetResponse(http=%p, resource=\"%s\")", http
, resource
));
351 * Connect to the default server as needed...
355 http
= _cupsConnect();
357 if (!http
|| (http
->state
!= HTTP_POST_RECV
&& http
->state
!= HTTP_POST_SEND
))
361 * Check for an unfinished chunked request...
364 if (http
->data_encoding
== HTTP_ENCODE_CHUNKED
)
367 * Send a 0-length chunk to finish off the request...
370 DEBUG_puts("2cupsGetResponse: Finishing chunked POST...");
372 if (httpWrite2(http
, "", 0) < 0)
377 * Wait for a response from the server...
380 DEBUG_printf(("2cupsGetResponse: Update loop, http->status=%d...",
383 status
= http
->status
;
384 while (status
== HTTP_CONTINUE
)
385 status
= httpUpdate(http
);
387 DEBUG_printf(("2cupsGetResponse: status=%d", status
));
389 if (status
== HTTP_OK
)
392 * Get the IPP response...
397 while ((state
= ippRead(http
, response
)) != IPP_DATA
)
398 if (state
== IPP_ERROR
)
401 if (state
== IPP_ERROR
)
404 * Delete the response...
407 DEBUG_puts("1cupsGetResponse: IPP read error!");
412 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
415 else if (status
!= HTTP_ERROR
)
418 * Flush any error message...
424 * Then handle encryption and authentication...
427 if (status
== HTTP_UNAUTHORIZED
)
430 * See if we can do authentication...
433 DEBUG_puts("2cupsGetResponse: Need authorization...");
435 if (!cupsDoAuthentication(http
, "POST", resource
))
440 else if (status
== HTTP_UPGRADE_REQUIRED
)
443 * Force a reconnect with encryption...
446 DEBUG_puts("2cupsGetResponse: Need encryption...");
448 if (!httpReconnect(http
))
449 httpEncryption(http
, HTTP_ENCRYPT_REQUIRED
);
451 #endif /* HAVE_SSL */
456 ipp_attribute_t
*attr
; /* status-message attribute */
459 attr
= ippFindAttribute(response
, "status-message", IPP_TAG_TEXT
);
461 DEBUG_printf(("1cupsGetResponse: status-code=%s, status-message=\"%s\"",
462 ippErrorString(response
->request
.status
.status_code
),
463 attr
? attr
->values
[0].string
.text
: ""));
465 _cupsSetError(response
->request
.status
.status_code
,
466 attr
? attr
->values
[0].string
.text
:
467 ippErrorString(response
->request
.status
.status_code
), 0);
469 else if (status
!= HTTP_OK
)
470 _cupsSetHTTPError(status
);
477 * 'cupsReadResponseData()' - Read additional data after the IPP response.
479 * This function is used after cupsGetResponse() to read the PPD or document
480 * files for CUPS_GET_PPD and CUPS_GET_DOCUMENT requests, respectively.
485 ssize_t
/* O - Bytes read, 0 on EOF, -1 on error */
486 cupsReadResponseData(
487 http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
488 char *buffer
, /* I - Buffer to use */
489 size_t length
) /* I - Number of bytes to read */
492 * Get the default connection as needed...
495 DEBUG_printf(("cupsReadResponseData(http=%p, buffer=%p, "
496 "length=" CUPS_LLFMT
")", http
, buffer
, CUPS_LLCAST length
));
500 _cups_globals_t
*cg
= _cupsGlobals();
501 /* Pointer to library globals */
503 if ((http
= cg
->http
) == NULL
)
505 _cupsSetError(IPP_INTERNAL_ERROR
, _("No active connection"), 1);
511 * Then read from the HTTP connection...
514 return (httpRead2(http
, buffer
, length
));
519 * 'cupsSendRequest()' - Send an IPP request.
521 * Use httpWrite() to write any additional data (document, PPD file, etc.)
522 * for the request, cupsGetResponse() to get the IPP response, and httpRead()
523 * to read any additional data following the response. Only one request can be
524 * sent/queued at a time.
526 * Unlike cupsDoFileRequest(), cupsDoIORequest(), and cupsDoRequest(), the
527 * request is not freed.
532 http_status_t
/* O - Initial HTTP status */
533 cupsSendRequest(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
534 ipp_t
*request
, /* I - IPP request */
535 const char *resource
, /* I - Resource path */
536 size_t length
) /* I - Length of data to follow or @code CUPS_LENGTH_VARIABLE@ */
538 http_status_t status
; /* Status of HTTP request */
539 int got_status
; /* Did we get the status? */
540 ipp_state_t state
; /* State of IPP processing */
541 http_status_t expect
; /* Expect: header to use */
544 DEBUG_printf(("cupsSendRequest(http=%p, request=%p(%s), resource=\"%s\", "
545 "length=" CUPS_LLFMT
")", http
, request
,
546 request
? ippOpString(request
->request
.op
.operation_id
) : "?",
547 resource
, CUPS_LLCAST length
));
550 * Range check input...
553 if (!request
|| !resource
)
555 _cupsSetError(IPP_INTERNAL_ERROR
, strerror(EINVAL
), 0);
561 * Get the default connection as needed...
565 if ((http
= _cupsConnect()) == NULL
)
566 return (HTTP_SERVICE_UNAVAILABLE
);
570 * See if we have an auth-info attribute and are communicating over
571 * a non-local link. If so, encrypt the link so that we can pass
572 * the authentication information securely...
575 if (ippFindAttribute(request
, "auth-info", IPP_TAG_TEXT
) &&
576 !httpAddrLocalhost(http
->hostaddr
) && !http
->tls
&&
577 httpEncryption(http
, HTTP_ENCRYPT_REQUIRED
))
579 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
580 return (HTTP_SERVICE_UNAVAILABLE
);
582 #endif /* HAVE_SSL */
585 * Reconnect if the last response had a "Connection: close"...
588 if (!strcasecmp(http
->fields
[HTTP_FIELD_CONNECTION
], "close"))
589 if (httpReconnect(http
))
591 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
592 return (HTTP_SERVICE_UNAVAILABLE
);
596 * Loop until we can send the request without authorization problems.
599 expect
= HTTP_CONTINUE
;
603 DEBUG_puts("2cupsSendRequest: Setup...");
606 * Setup the HTTP variables needed...
609 httpClearFields(http
);
610 httpSetLength(http
, length
);
611 httpSetField(http
, HTTP_FIELD_CONTENT_TYPE
, "application/ipp");
612 httpSetField(http
, HTTP_FIELD_AUTHORIZATION
, http
->authstring
);
613 httpSetExpect(http
, expect
);
615 DEBUG_printf(("2cupsSendRequest: authstring=\"%s\"", http
->authstring
));
621 DEBUG_puts("2cupsSendRequest: Sending HTTP POST...");
623 if (httpPost(http
, resource
))
625 if (httpReconnect(http
))
627 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
628 return (HTTP_SERVICE_UNAVAILABLE
);
635 * Send the IPP data...
638 DEBUG_puts("2cupsSendRequest: Writing IPP request...");
640 request
->state
= IPP_IDLE
;
641 status
= HTTP_CONTINUE
;
644 while ((state
= ippWrite(http
, request
)) != IPP_DATA
)
645 if (state
== IPP_ERROR
)
647 else if (httpCheck(http
))
651 if ((status
= httpUpdate(http
)) != HTTP_CONTINUE
)
656 * Wait up to 1 second to get the 100-continue response as needed...
659 if (!got_status
&& expect
== HTTP_CONTINUE
)
661 DEBUG_puts("2cupsSendRequest: Waiting for 100-continue...");
663 if (httpWait(http
, 1000))
664 status
= httpUpdate(http
);
666 else if (httpCheck(http
))
667 status
= httpUpdate(http
);
669 DEBUG_printf(("2cupsSendRequest: status=%d", status
));
672 * Process the current HTTP status...
682 case HTTP_UNAUTHORIZED
:
683 if (!cupsDoAuthentication(http
, "POST", resource
))
684 if (httpReconnect(http
))
686 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
687 return (HTTP_SERVICE_UNAVAILABLE
);
693 case HTTP_UPGRADE_REQUIRED
:
695 * Flush any error message, reconnect, and then upgrade with
699 if (httpReconnect(http
))
701 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
702 return (HTTP_SERVICE_UNAVAILABLE
);
705 httpEncryption(http
, HTTP_ENCRYPT_REQUIRED
);
708 #endif /* HAVE_SSL */
710 case HTTP_EXPECTATION_FAILED
:
712 * Don't try using the Expect: header the next time around...
715 expect
= (http_status_t
)0;
717 if (httpReconnect(http
))
719 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
720 return (HTTP_SERVICE_UNAVAILABLE
);
726 * Some other error...
736 * 'cupsWriteRequestData()' - Write additional data after an IPP request.
738 * This function is used after @link cupsSendRequest@ to provide a PPD and
739 * after @link cupsStartDocument@ to provide a document file.
744 http_status_t
/* O - @code HTTP_CONTINUE@ if OK or HTTP status on error */
745 cupsWriteRequestData(
746 http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
747 const char *buffer
, /* I - Bytes to write */
748 size_t length
) /* I - Number of bytes to write */
750 int wused
; /* Previous bytes in buffer */
754 * Get the default connection as needed...
757 DEBUG_printf(("cupsWriteRequestData(http=%p, buffer=%p, "
758 "length=" CUPS_LLFMT
")", http
, buffer
, CUPS_LLCAST length
));
762 _cups_globals_t
*cg
= _cupsGlobals();
763 /* Pointer to library globals */
765 if ((http
= cg
->http
) == NULL
)
767 _cupsSetError(IPP_INTERNAL_ERROR
, _("No active connection"), 1);
773 * Then write to the HTTP connection...
778 if (httpWrite2(http
, buffer
, length
) < 0)
782 * Finally, check if we have any pending data from the server...
785 if (length
> HTTP_MAX_BUFFER
||
786 http
->wused
< wused
||
787 (wused
> 0 && http
->wused
== length
))
790 * We've written something to the server, so check for response data...
793 if (_httpWait(http
, 0, 1))
794 return (httpUpdate(http
));
797 return (HTTP_CONTINUE
);
802 * '_cupsSetError()' - Set the last IPP status code and status-message.
806 _cupsSetError(ipp_status_t status
, /* I - IPP status code */
807 const char *message
, /* I - status-message value */
808 int localize
) /* I - Localize the message? */
810 _cups_globals_t
*cg
; /* Global data */
813 if (!message
&& errno
)
815 message
= strerror(errno
);
820 cg
->last_error
= status
;
822 if (cg
->last_status_message
)
824 _cupsStrFree(cg
->last_status_message
);
826 cg
->last_status_message
= NULL
;
834 * Get the message catalog...
837 if (!cg
->lang_default
)
838 cg
->lang_default
= cupsLangDefault();
840 cg
->last_status_message
= _cupsStrAlloc(_cupsLangString(cg
->lang_default
,
844 cg
->last_status_message
= _cupsStrAlloc(message
);
847 DEBUG_printf(("4_cupsSetError: last_error=%s, last_status_message=\"%s\"",
848 ippErrorString(cg
->last_error
), cg
->last_status_message
));
853 * '_cupsSetHTTPError()' - Set the last error using the HTTP status.
857 _cupsSetHTTPError(http_status_t status
) /* I - HTTP status code */
861 case HTTP_NOT_FOUND
:
862 _cupsSetError(IPP_NOT_FOUND
, httpStatus(status
), 0);
865 case HTTP_UNAUTHORIZED
:
866 _cupsSetError(IPP_NOT_AUTHORIZED
, httpStatus(status
), 0);
869 case HTTP_FORBIDDEN
:
870 _cupsSetError(IPP_FORBIDDEN
, httpStatus(status
), 0);
873 case HTTP_BAD_REQUEST
:
874 _cupsSetError(IPP_BAD_REQUEST
, httpStatus(status
), 0);
877 case HTTP_REQUEST_TOO_LARGE
:
878 _cupsSetError(IPP_REQUEST_VALUE
, httpStatus(status
), 0);
881 case HTTP_NOT_IMPLEMENTED
:
882 _cupsSetError(IPP_OPERATION_NOT_SUPPORTED
, httpStatus(status
), 0);
885 case HTTP_NOT_SUPPORTED
:
886 _cupsSetError(IPP_VERSION_NOT_SUPPORTED
, httpStatus(status
), 0);
890 DEBUG_printf(("4_cupsSetHTTPError: HTTP error %d mapped to "
891 "IPP_SERVICE_UNAVAILABLE!", status
));
892 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, httpStatus(status
), 0);
899 * End of "$Id: request.c 7946 2008-09-16 23:27:54Z mike $".