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\")\n", http
, request
,
70 request
? ippOpString(request
->request
.op
.operation_id
) : "?",
71 resource
? resource
: "(null)",
72 filename
? filename
: "(null)"));
76 if ((infile
= open(filename
, O_RDONLY
| O_BINARY
)) < 0)
79 * Can't get file information!
82 _cupsSetError(errno
== ENOENT
? IPP_NOT_FOUND
: IPP_NOT_AUTHORIZED
,
93 response
= cupsDoIORequest(http
, request
, resource
, infile
, -1);
103 * 'cupsDoIORequest()' - Do an IPP request with file descriptors.
105 * This function sends the IPP request to the specified server, retrying
106 * and authenticating as necessary. The request is freed with ippDelete()
107 * after receiving a valid IPP response.
109 * If "infile" is a valid file descriptor, cupsDoIORequest() copies
110 * all of the data from the file after the IPP request message.
112 * If "outfile" is a valid file descriptor, cupsDoIORequest() copies
113 * all of the data after the IPP response message to the file.
115 * @since CUPS 1.3/Mac OS X 10.5@
118 ipp_t
* /* O - Response data */
119 cupsDoIORequest(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
120 ipp_t
*request
, /* I - IPP request */
121 const char *resource
, /* I - HTTP resource for POST */
122 int infile
, /* I - File to read from or -1 for none */
123 int outfile
) /* I - File to write to or -1 for none */
125 ipp_t
*response
= NULL
; /* IPP response data */
126 size_t length
= 0; /* Content-Length value */
127 http_status_t status
; /* Status of HTTP request */
128 struct stat fileinfo
; /* File information */
129 int bytes
; /* Number of bytes read/written */
130 char buffer
[32768]; /* Output buffer */
133 DEBUG_printf(("cupsDoIORequest(http=%p, request=%p(%s), resource=\"%s\", "
134 "infile=%d, outfile=%d)\n", http
, request
,
135 request
? ippOpString(request
->request
.op
.operation_id
) : "?",
136 resource
? resource
: "(null)", infile
, outfile
));
139 * Range check input...
142 if (!request
|| !resource
)
146 _cupsSetError(IPP_INTERNAL_ERROR
, strerror(EINVAL
), 0);
152 * Get the default connection as needed...
156 if ((http
= _cupsConnect()) == NULL
)
160 * See if we have a file to send...
165 if (fstat(infile
, &fileinfo
))
168 * Can't get file information!
171 _cupsSetError(errno
== EBADF
? IPP_NOT_FOUND
: IPP_NOT_AUTHORIZED
,
180 if (fileinfo
.st_mode
& _S_IFDIR
)
182 if (S_ISDIR(fileinfo
.st_mode
))
186 * Can't send a directory...
191 _cupsSetError(IPP_NOT_POSSIBLE
, strerror(EISDIR
), 0);
197 if (!S_ISREG(fileinfo
.st_mode
))
198 length
= 0; /* Chunk when piping */
201 length
= ippLength(request
) + fileinfo
.st_size
;
204 length
= ippLength(request
);
206 DEBUG_printf(("cupsDoIORequest: Request length=%ld, total length=%ld",
207 (long)ippLength(request
), (long)length
));
210 * Clear any "Local" authentication data since it is probably stale...
213 if (http
->authstring
&& !strncmp(http
->authstring
, "Local ", 6))
214 httpSetAuthString(http
, NULL
, NULL
);
217 * Loop until we can send the request without authorization problems.
220 while (response
== NULL
)
222 DEBUG_puts("cupsDoIORequest: setup...");
225 * Send the request...
228 status
= cupsSendRequest(http
, request
, resource
, length
);
230 DEBUG_printf(("cupsDoIORequest: status=%d\n", status
));
232 if (status
== HTTP_CONTINUE
&& request
->state
== IPP_DATA
&& infile
>= 0)
234 DEBUG_puts("cupsDoIORequest: file write...");
237 * Send the file with the request...
241 if (S_ISREG(fileinfo
.st_mode
))
243 lseek(infile
, 0, SEEK_SET
);
245 while ((bytes
= (int)read(infile
, buffer
, sizeof(buffer
))) > 0)
249 if ((status
= httpUpdate(http
)) != HTTP_CONTINUE
)
253 if (httpWrite2(http
, buffer
, bytes
) < bytes
)
259 * Get the server's response...
262 if (status
== HTTP_CONTINUE
|| status
== HTTP_OK
)
264 response
= cupsGetResponse(http
, resource
);
265 status
= http
->status
;
268 if (status
== HTTP_FORBIDDEN
|| status
== HTTP_ERROR
||
269 status
>= HTTP_SERVER_ERROR
)
271 _cupsSetHTTPError(status
);
280 * Write trailing data to file...
283 while ((bytes
= (int)httpRead2(http
, buffer
, sizeof(buffer
))) > 0)
284 if (write(outfile
, buffer
, bytes
) < bytes
)
290 * Flush any remaining data...
299 * Delete the original request and return the response...
309 * 'cupsDoRequest()' - Do an IPP request.
311 * This function sends the IPP request to the specified server, retrying
312 * and authenticating as necessary. The request is freed with ippDelete()
313 * after receiving a valid IPP response.
316 ipp_t
* /* O - Response data */
317 cupsDoRequest(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
318 ipp_t
*request
, /* I - IPP request */
319 const char *resource
) /* I - HTTP resource for POST */
321 DEBUG_printf(("cupsDoRequest(http=%p, request=%p(%s), resource=\"%s\")\n",
323 request
? ippOpString(request
->request
.op
.operation_id
) : "?",
324 resource
? resource
: "(null)"));
326 return (cupsDoIORequest(http
, request
, resource
, -1, -1));
331 * 'cupsGetResponse()' - Get a response to an IPP request.
333 * Use this function to get the response for an IPP request sent using
334 * cupsSendDocument() or cupsSendRequest(). For requests that return
335 * additional data, use httpRead() after getting a successful response.
340 ipp_t
* /* O - Response or @code NULL@ on HTTP error */
341 cupsGetResponse(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
342 const char *resource
) /* I - HTTP resource for POST */
344 http_status_t status
; /* HTTP status */
345 ipp_state_t state
; /* IPP read state */
346 ipp_t
*response
= NULL
; /* IPP response */
349 DEBUG_printf(("cupsGetReponse(http=%p, resource=\"%s\")\n", http
,
350 resource
? resource
: "(null)"));
353 * Connect to the default server as needed...
357 http
= _cupsConnect();
359 if (!http
|| (http
->state
!= HTTP_POST_RECV
&& http
->state
!= HTTP_POST_SEND
))
363 * Check for an unfinished chunked request...
366 if (http
->data_encoding
== HTTP_ENCODE_CHUNKED
)
369 * Send a 0-length chunk to finish off the request...
372 DEBUG_puts("cupsGetResponse: Finishing chunked POST...");
374 if (httpWrite2(http
, "", 0) < 0)
379 * Wait for a response from the server...
382 DEBUG_printf(("cupsGetResponse: Update loop, http->status=%d...\n",
385 status
= http
->status
;
386 while (status
== HTTP_CONTINUE
)
387 status
= httpUpdate(http
);
389 DEBUG_printf(("cupsGetResponse: status=%d\n", status
));
391 if (status
== HTTP_OK
)
394 * Get the IPP response...
399 while ((state
= ippRead(http
, response
)) != IPP_DATA
)
400 if (state
== IPP_ERROR
)
403 if (state
== IPP_ERROR
)
406 * Delete the response...
409 DEBUG_puts("cupsGetResponse: IPP read error!");
414 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
417 else if (status
!= HTTP_ERROR
)
420 * Flush any error message...
426 * Then handle encryption and authentication...
429 if (status
== HTTP_UNAUTHORIZED
)
432 * See if we can do authentication...
437 DEBUG_puts("cupsGetResponse: Need authorization...");
439 if ((auth_result
= cupsDoAuthentication(http
, "POST", resource
)) == 0)
441 else if (auth_result
< 0)
442 http
->status
= status
= HTTP_FORBIDDEN
;
446 else if (status
== HTTP_UPGRADE_REQUIRED
)
449 * Force a reconnect with encryption...
452 DEBUG_puts("cupsGetResponse: Need encryption...");
454 if (!httpReconnect(http
))
455 httpEncryption(http
, HTTP_ENCRYPT_REQUIRED
);
457 #endif /* HAVE_SSL */
462 ipp_attribute_t
*attr
; /* status-message attribute */
465 attr
= ippFindAttribute(response
, "status-message", IPP_TAG_TEXT
);
467 DEBUG_printf(("cupsGetResponse: status-code=%s, status-message=\"%s\"\n",
468 ippErrorString(response
->request
.status
.status_code
),
469 attr
? attr
->values
[0].string
.text
: ""));
471 _cupsSetError(response
->request
.status
.status_code
,
472 attr
? attr
->values
[0].string
.text
:
473 ippErrorString(response
->request
.status
.status_code
), 0);
475 else if (status
!= HTTP_OK
)
476 _cupsSetHTTPError(status
);
483 * 'cupsReadResponseData()' - Read additional data after the IPP response.
485 * This function is used after cupsGetResponse() to read the PPD or document
486 * files for CUPS_GET_PPD and CUPS_GET_DOCUMENT requests, respectively.
491 ssize_t
/* O - Bytes read, 0 on EOF, -1 on error */
492 cupsReadResponseData(
493 http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
494 char *buffer
, /* I - Buffer to use */
495 size_t length
) /* I - Number of bytes to read */
498 * Get the default connection as needed...
501 DEBUG_printf(("cupsReadResponseData(http=%p, buffer=%p, "
502 "length=" CUPS_LLFMT
")\n", http
, buffer
, CUPS_LLCAST length
));
506 _cups_globals_t
*cg
= _cupsGlobals();
507 /* Pointer to library globals */
509 if ((http
= cg
->http
) == NULL
)
511 _cupsSetError(IPP_INTERNAL_ERROR
, _("No active connection"), 1);
517 * Then read from the HTTP connection...
520 return (httpRead2(http
, buffer
, length
));
525 * 'cupsSendRequest()' - Send an IPP request.
527 * Use httpWrite() to write any additional data (document, PPD file, etc.)
528 * for the request, cupsGetResponse() to get the IPP response, and httpRead()
529 * to read any additional data following the response. Only one request can be
530 * sent/queued at a time.
532 * Unlike cupsDoFileRequest(), cupsDoIORequest(), and cupsDoRequest(), the
533 * request is not freed.
538 http_status_t
/* O - Initial HTTP status */
539 cupsSendRequest(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
540 ipp_t
*request
, /* I - IPP request */
541 const char *resource
, /* I - Resource path */
542 size_t length
) /* I - Length of data to follow or @code CUPS_LENGTH_VARIABLE@ */
544 http_status_t status
; /* Status of HTTP request */
545 int got_status
; /* Did we get the status? */
546 ipp_state_t state
; /* State of IPP processing */
547 http_status_t expect
; /* Expect: header to use */
550 DEBUG_printf(("cupsSendRequest(http=%p, request=%p(%s), resource=\"%s\", "
551 "length=" CUPS_LLFMT
")\n", http
, request
,
552 request
? ippOpString(request
->request
.op
.operation_id
) : "?",
553 resource
? resource
: "(null)", CUPS_LLCAST length
));
556 * Range check input...
559 if (!request
|| !resource
)
561 _cupsSetError(IPP_INTERNAL_ERROR
, strerror(EINVAL
), 0);
567 * Get the default connection as needed...
571 if ((http
= _cupsConnect()) == NULL
)
572 return (HTTP_SERVICE_UNAVAILABLE
);
576 * See if we have an auth-info attribute and are communicating over
577 * a non-local link. If so, encrypt the link so that we can pass
578 * the authentication information securely...
581 if (ippFindAttribute(request
, "auth-info", IPP_TAG_TEXT
) &&
582 !httpAddrLocalhost(http
->hostaddr
) && !http
->tls
&&
583 httpEncryption(http
, HTTP_ENCRYPT_REQUIRED
))
585 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
586 return (HTTP_SERVICE_UNAVAILABLE
);
588 #endif /* HAVE_SSL */
591 * Reconnect if the last response had a "Connection: close"...
594 if (!strcasecmp(http
->fields
[HTTP_FIELD_CONNECTION
], "close"))
595 if (httpReconnect(http
))
597 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
598 return (HTTP_SERVICE_UNAVAILABLE
);
602 * Loop until we can send the request without authorization problems.
605 expect
= HTTP_CONTINUE
;
609 DEBUG_puts("cupsSendRequest: Setup...");
612 * Setup the HTTP variables needed...
615 httpClearFields(http
);
616 httpSetLength(http
, length
);
617 httpSetField(http
, HTTP_FIELD_CONTENT_TYPE
, "application/ipp");
618 httpSetField(http
, HTTP_FIELD_AUTHORIZATION
, http
->authstring
);
619 httpSetExpect(http
, expect
);
621 DEBUG_printf(("cupsSendRequest: authstring=\"%s\"\n", http
->authstring
));
627 DEBUG_puts("cupsSendRequest: Sending HTTP POST...");
629 if (httpPost(http
, resource
))
631 if (httpReconnect(http
))
633 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
634 return (HTTP_SERVICE_UNAVAILABLE
);
641 * Send the IPP data...
644 DEBUG_puts("cupsSendRequest: Writing IPP request...");
646 request
->state
= IPP_IDLE
;
647 status
= HTTP_CONTINUE
;
650 while ((state
= ippWrite(http
, request
)) != IPP_DATA
)
651 if (state
== IPP_ERROR
)
653 else if (httpCheck(http
))
657 if ((status
= httpUpdate(http
)) != HTTP_CONTINUE
)
662 * Wait up to 1 second to get the 100-continue response as needed...
665 if (!got_status
&& expect
== HTTP_CONTINUE
)
667 DEBUG_puts("cupsSendRequest: Waiting for 100-continue...");
669 if (httpWait(http
, 1000))
670 status
= httpUpdate(http
);
672 else if (httpCheck(http
))
673 status
= httpUpdate(http
);
675 DEBUG_printf(("cupsSendRequest: status=%d\n", status
));
678 * Process the current HTTP status...
688 case HTTP_UNAUTHORIZED
:
689 if (!cupsDoAuthentication(http
, "POST", resource
))
690 if (httpReconnect(http
))
692 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
693 return (HTTP_SERVICE_UNAVAILABLE
);
699 case HTTP_UPGRADE_REQUIRED
:
701 * Flush any error message, reconnect, and then upgrade with
705 if (httpReconnect(http
))
707 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
708 return (HTTP_SERVICE_UNAVAILABLE
);
711 httpEncryption(http
, HTTP_ENCRYPT_REQUIRED
);
714 #endif /* HAVE_SSL */
716 case HTTP_EXPECTATION_FAILED
:
718 * Don't try using the Expect: header the next time around...
721 expect
= (http_status_t
)0;
723 if (httpReconnect(http
))
725 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, NULL
, 0);
726 return (HTTP_SERVICE_UNAVAILABLE
);
732 * Some other error...
742 * 'cupsWriteRequestData()' - Write additional data after an IPP request.
744 * This function is used after @link cupsSendRequest@ to provide a PPD and
745 * after @link cupsStartDocument@ to provide a document file.
750 http_status_t
/* O - @code HTTP_CONTINUE@ if OK or HTTP status on error */
751 cupsWriteRequestData(
752 http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
753 const char *buffer
, /* I - Bytes to write */
754 size_t length
) /* I - Number of bytes to write */
756 int wused
; /* Previous bytes in buffer */
760 * Get the default connection as needed...
763 DEBUG_printf(("cupsWriteRequestData(http=%p, buffer=%p, "
764 "length=" CUPS_LLFMT
")\n", http
, buffer
, CUPS_LLCAST length
));
768 _cups_globals_t
*cg
= _cupsGlobals();
769 /* Pointer to library globals */
771 if ((http
= cg
->http
) == NULL
)
773 _cupsSetError(IPP_INTERNAL_ERROR
, _("No active connection"), 1);
779 * Then write to the HTTP connection...
784 if (httpWrite2(http
, buffer
, length
) < 0)
788 * Finally, check if we have any pending data from the server...
791 if (length
> HTTP_MAX_BUFFER
||
792 http
->wused
< wused
||
793 (wused
> 0 && http
->wused
== length
))
796 * We've written something to the server, so check for response data...
799 if (_httpWait(http
, 0, 1))
800 return (httpUpdate(http
));
803 return (HTTP_CONTINUE
);
808 * '_cupsSetError()' - Set the last IPP status code and status-message.
812 _cupsSetError(ipp_status_t status
, /* I - IPP status code */
813 const char *message
, /* I - status-message value */
814 int localize
) /* I - Localize the message? */
816 _cups_globals_t
*cg
; /* Global data */
819 if (!message
&& errno
)
821 message
= strerror(errno
);
826 cg
->last_error
= status
;
828 if (cg
->last_status_message
)
830 _cupsStrFree(cg
->last_status_message
);
832 cg
->last_status_message
= NULL
;
840 * Get the message catalog...
843 if (!cg
->lang_default
)
844 cg
->lang_default
= cupsLangDefault();
846 cg
->last_status_message
= _cupsStrAlloc(_cupsLangString(cg
->lang_default
,
850 cg
->last_status_message
= _cupsStrAlloc(message
);
853 DEBUG_printf(("_cupsSetError: last_error=%s, last_status_message=\"%s\"\n",
854 ippErrorString(cg
->last_error
),
855 cg
->last_status_message
? cg
->last_status_message
: ""));
860 * '_cupsSetHTTPError()' - Set the last error using the HTTP status.
864 _cupsSetHTTPError(http_status_t status
) /* I - HTTP status code */
868 case HTTP_NOT_FOUND
:
869 _cupsSetError(IPP_NOT_FOUND
, httpStatus(status
), 0);
872 case HTTP_UNAUTHORIZED
:
873 _cupsSetError(IPP_NOT_AUTHORIZED
, httpStatus(status
), 0);
876 case HTTP_FORBIDDEN
:
877 _cupsSetError(IPP_FORBIDDEN
, httpStatus(status
), 0);
880 case HTTP_BAD_REQUEST
:
881 _cupsSetError(IPP_BAD_REQUEST
, httpStatus(status
), 0);
884 case HTTP_REQUEST_TOO_LARGE
:
885 _cupsSetError(IPP_REQUEST_VALUE
, httpStatus(status
), 0);
888 case HTTP_NOT_IMPLEMENTED
:
889 _cupsSetError(IPP_OPERATION_NOT_SUPPORTED
, httpStatus(status
), 0);
892 case HTTP_NOT_SUPPORTED
:
893 _cupsSetError(IPP_VERSION_NOT_SUPPORTED
, httpStatus(status
), 0);
897 DEBUG_printf(("HTTP error %d mapped to IPP_SERVICE_UNAVAILABLE!\n",
899 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, httpStatus(status
), 0);
906 * End of "$Id: request.c 7946 2008-09-16 23:27:54Z mike $".