2 * "$Id: request.c 6416 2007-03-30 18:30:33Z 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
,
149 * See if we have an auth-info attribute and are communicating over
150 * a non-local link. If so, encrypt the link so that we can pass
151 * the authentication information securely...
154 if (ippFindAttribute(request
, "auth-info", IPP_TAG_TEXT
) &&
155 !httpAddrLocalhost(http
->hostaddr
) && !http
->tls
&&
156 httpEncryption(http
, HTTP_ENCRYPT_REQUIRED
))
158 #endif /* HAVE_SSL */
161 * Loop until we can send the request without authorization problems.
166 expect
= HTTP_CONTINUE
;
168 while (response
== NULL
)
170 DEBUG_puts("cupsDoFileRequest: setup...");
173 * Setup the HTTP variables needed...
176 length
= ippLength(request
);
178 length
+= fileinfo
.st_size
;
180 httpClearFields(http
);
181 httpSetLength(http
, length
);
182 httpSetField(http
, HTTP_FIELD_CONTENT_TYPE
, "application/ipp");
183 httpSetField(http
, HTTP_FIELD_AUTHORIZATION
, http
->authstring
);
184 httpSetExpect(http
, expect
);
186 DEBUG_printf(("cupsDoFileRequest: authstring=\"%s\"\n", http
->authstring
));
192 DEBUG_puts("cupsDoFileRequest: post...");
194 if (httpPost(http
, resource
))
196 if (httpReconnect(http
))
206 * Send the IPP data...
209 DEBUG_puts("cupsDoFileRequest: ipp write...");
211 request
->state
= IPP_IDLE
;
212 status
= HTTP_CONTINUE
;
215 while ((state
= ippWrite(http
, request
)) != IPP_DATA
)
216 if (state
== IPP_ERROR
)
218 else if (httpCheck(http
))
222 if ((status
= httpUpdate(http
)) != HTTP_CONTINUE
)
229 * Wait up to 1 second to get the 100-continue response...
232 if (httpWait(http
, 1000))
233 status
= httpUpdate(http
);
235 else if (httpCheck(http
))
236 status
= httpUpdate(http
);
238 if (status
== HTTP_CONTINUE
&& state
== IPP_DATA
&& filename
)
240 DEBUG_puts("cupsDoFileRequest: file write...");
248 while ((bytes
= (int)fread(buffer
, 1, sizeof(buffer
), file
)) > 0)
252 if ((status
= httpUpdate(http
)) != HTTP_CONTINUE
)
256 if (httpWrite2(http
, buffer
, bytes
) < bytes
)
262 * Get the server's return status...
265 DEBUG_puts("cupsDoFileRequest: update...");
267 while (status
== HTTP_CONTINUE
)
268 status
= httpUpdate(http
);
270 DEBUG_printf(("cupsDoFileRequest: status = %d\n", status
));
272 if (status
== HTTP_UNAUTHORIZED
)
274 DEBUG_puts("cupsDoFileRequest: unauthorized...");
277 * Flush any error message...
283 * See if we can do authentication...
286 if (cupsDoAuthentication(http
, "POST", resource
))
289 if (httpReconnect(http
))
297 else if (status
== HTTP_ERROR
)
299 DEBUG_printf(("cupsDoFileRequest: http->error=%d (%s)\n", http
->error
,
300 strerror(http
->error
)));
303 if (http
->error
!= WSAENETDOWN
&& http
->error
!= WSAENETUNREACH
&&
304 http
->error
!= WSAETIMEDOUT
)
306 if (http
->error
!= ENETDOWN
&& http
->error
!= ENETUNREACH
&&
307 http
->error
!= ETIMEDOUT
)
314 else if (status
== HTTP_UPGRADE_REQUIRED
)
316 /* Flush any error message... */
320 if (httpReconnect(http
))
326 /* Upgrade with encryption... */
327 httpEncryption(http
, HTTP_ENCRYPT_REQUIRED
);
329 /* Try again, this time with encryption enabled... */
332 #endif /* HAVE_SSL */
333 else if (status
== HTTP_EXPECTATION_FAILED
)
336 * Don't try using the Expect: header the next time around...
339 expect
= (http_status_t
)0;
341 else if (status
!= HTTP_OK
)
343 DEBUG_printf(("cupsDoFileRequest: error %d...\n", status
));
346 * Flush any error message...
355 * Read the response...
358 DEBUG_puts("cupsDoFileRequest: response...");
362 while ((state
= ippRead(http
, response
)) != IPP_DATA
)
363 if (state
== IPP_ERROR
)
366 if (state
== IPP_ERROR
)
369 * Delete the response...
372 DEBUG_puts("IPP read error!");
376 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, strerror(errno
));
384 * Close the file if needed...
387 if (filename
!= NULL
)
391 * Flush any remaining data...
397 * Delete the original request and return the response...
404 ipp_attribute_t
*attr
; /* status-message attribute */
407 attr
= ippFindAttribute(response
, "status-message", IPP_TAG_TEXT
);
409 _cupsSetError(response
->request
.status
.status_code
,
410 attr
? attr
->values
[0].string
.text
:
411 ippErrorString(response
->request
.status
.status_code
));
413 else if (status
!= HTTP_OK
)
417 case HTTP_NOT_FOUND
:
418 _cupsSetError(IPP_NOT_FOUND
, httpStatus(status
));
421 case HTTP_UNAUTHORIZED
:
422 _cupsSetError(IPP_NOT_AUTHORIZED
, httpStatus(status
));
425 case HTTP_FORBIDDEN
:
426 _cupsSetError(IPP_FORBIDDEN
, httpStatus(status
));
429 case HTTP_BAD_REQUEST
:
430 _cupsSetError(IPP_BAD_REQUEST
, httpStatus(status
));
433 case HTTP_REQUEST_TOO_LARGE
:
434 _cupsSetError(IPP_REQUEST_VALUE
, httpStatus(status
));
437 case HTTP_NOT_IMPLEMENTED
:
438 _cupsSetError(IPP_OPERATION_NOT_SUPPORTED
, httpStatus(status
));
441 case HTTP_NOT_SUPPORTED
:
442 _cupsSetError(IPP_VERSION_NOT_SUPPORTED
, httpStatus(status
));
446 DEBUG_printf(("HTTP error %d mapped to IPP_SERVICE_UNAVAILABLE!\n",
448 _cupsSetError(IPP_SERVICE_UNAVAILABLE
, httpStatus(status
));
453 #ifdef HAVE_AUTHORIZATION_H
455 * Delete any authorization reference created for this request...
460 AuthorizationFree(cg
->auth_ref
, kAuthorizationFlagDefaults
);
463 #endif /* HAVE_AUTHORIZATION_H */
470 * 'cupsDoRequest()' - Do an IPP request.
472 * This function sends the IPP request to the specified server, retrying
473 * and authenticating as necessary. The request is freed with ippDelete()
474 * after receiving a valid IPP response.
477 ipp_t
* /* O - Response data */
478 cupsDoRequest(http_t
*http
, /* I - HTTP connection to server */
479 ipp_t
*request
, /* I - IPP request */
480 const char *resource
) /* I - HTTP resource for POST */
482 return (cupsDoFileRequest(http
, request
, resource
, NULL
));
487 * '_cupsSetError()' - Set the last IPP status code and status-message.
491 _cupsSetError(ipp_status_t status
, /* I - IPP status code */
492 const char *message
) /* I - status-message value */
494 _cups_globals_t
*cg
; /* Global data */
498 cg
->last_error
= status
;
500 if (cg
->last_status_message
)
502 free(cg
->last_status_message
);
504 cg
->last_status_message
= NULL
;
508 cg
->last_status_message
= strdup(message
);
513 * End of "$Id: request.c 6416 2007-03-30 18:30:33Z mike $".