1 /* GTK - The GIMP Toolkit
2 * gtkcupsutils.h: Statemachine implementation of POST and GET
3 * cups calls which can be used to create a non-blocking cups API
4 * Copyright (C) 2006, 2007 Red Hat, Inc.
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
22 #include "gtkcupsutils.h"
26 #include <sys/types.h>
31 #include <sys/socket.h>
33 typedef void (*GtkCupsRequestStateFunc) (GtkCupsRequest *request);
35 static void _connect (GtkCupsRequest *request);
36 static void _post_send (GtkCupsRequest *request);
37 static void _post_write_request (GtkCupsRequest *request);
38 static void _post_write_data (GtkCupsRequest *request);
39 static void _post_check (GtkCupsRequest *request);
40 static void _post_auth (GtkCupsRequest *request);
41 static void _post_read_response (GtkCupsRequest *request);
43 static void _get_send (GtkCupsRequest *request);
44 static void _get_check (GtkCupsRequest *request);
45 static void _get_auth (GtkCupsRequest *request);
46 static void _get_read_data (GtkCupsRequest *request);
52 GtkCupsErrorType error_type;
54 /* some error types like HTTP_ERROR have a status and a code */
59 guint is_ipp_response : 1;
63 #define _GTK_CUPS_MAX_ATTEMPTS 10
64 #define _GTK_CUPS_MAX_CHUNK_SIZE 8192
66 static GtkCupsRequestStateFunc post_states[] = {
76 static GtkCupsRequestStateFunc get_states[] = {
85 gtk_cups_result_set_error (GtkCupsResult *result,
86 GtkCupsErrorType error_type,
89 const char *error_msg,
94 result->is_ipp_response = FALSE;
95 result->is_error = TRUE;
96 result->error_type = error_type;
97 result->error_status = error_status;
98 result->error_code = error_code;
100 va_start (args, error_msg);
101 result->error_msg = g_strdup_vprintf (error_msg, args);
106 gtk_cups_request_new_with_username (http_t *connection,
107 GtkCupsRequestType req_type,
111 const char *resource,
112 const char *username)
114 GtkCupsRequest *request;
115 cups_lang_t *language;
117 request = g_new0 (GtkCupsRequest, 1);
118 request->result = g_new0 (GtkCupsResult, 1);
120 request->result->error_msg = NULL;
121 request->result->ipp_response = NULL;
123 request->result->is_error = FALSE;
124 request->result->is_ipp_response = FALSE;
126 request->type = req_type;
127 request->state = GTK_CUPS_REQUEST_START;
129 request->password_state = GTK_CUPS_PASSWORD_NONE;
132 request->server = g_strdup (server);
134 request->server = g_strdup (cupsServer ());
138 request->resource = g_strdup (resource);
140 request->resource = g_strdup ("/");
142 if (connection != NULL)
144 request->http = connection;
145 request->own_http = FALSE;
149 request->http = NULL;
150 request->http = httpConnectEncrypt (request->server,
155 httpBlocking (request->http, 0);
157 request->own_http = TRUE;
160 request->last_status = HTTP_CONTINUE;
162 request->attempts = 0;
163 request->data_io = data_io;
165 request->ipp_request = ippNew ();
166 request->ipp_request->request.op.operation_id = operation_id;
167 request->ipp_request->request.op.request_id = 1;
169 language = cupsLangDefault ();
171 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION, IPP_TAG_CHARSET,
172 "attributes-charset",
175 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION, IPP_TAG_LANGUAGE,
176 "attributes-natural-language",
177 NULL, language->language);
179 if (username != NULL)
180 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION, IPP_TAG_NAME,
181 "requesting-user-name",
184 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION, IPP_TAG_NAME,
185 "requesting-user-name",
188 request->auth_info_required = NULL;
189 request->auth_info = NULL;
190 request->need_auth_info = FALSE;
192 cupsLangFree (language);
198 gtk_cups_request_new (http_t *connection,
199 GtkCupsRequestType req_type,
203 const char *resource)
205 return gtk_cups_request_new_with_username (connection,
215 gtk_cups_result_free (GtkCupsResult *result)
217 g_free (result->error_msg);
219 if (result->ipp_response)
220 ippDelete (result->ipp_response);
226 gtk_cups_request_free (GtkCupsRequest *request)
228 if (request->own_http)
231 httpClose (request->http);
234 if (request->ipp_request)
235 ippDelete (request->ipp_request);
237 g_free (request->server);
238 g_free (request->resource);
239 if (request->password != NULL)
241 memset (request->password, 0, strlen (request->password));
242 g_free (request->password);
245 g_free (request->username);
246 g_strfreev (request->auth_info_required);
248 gtk_cups_result_free (request->result);
254 gtk_cups_request_read_write (GtkCupsRequest *request, gboolean connect_only)
256 if (connect_only && request->state != GTK_CUPS_REQUEST_START)
261 if (request->type == GTK_CUPS_POST)
262 post_states[request->state] (request);
263 else if (request->type == GTK_CUPS_GET)
264 get_states[request->state] (request);
266 if (gtk_cups_result_is_error (request->result))
267 request->state = GTK_CUPS_REQUEST_DONE;
269 if (request->attempts > _GTK_CUPS_MAX_ATTEMPTS &&
270 request->state != GTK_CUPS_REQUEST_DONE)
272 /* TODO: should add a status or error code for too many failed attempts */
273 gtk_cups_result_set_error (request->result,
274 GTK_CUPS_ERROR_GENERAL,
277 "Too many failed attempts");
279 request->state = GTK_CUPS_REQUEST_DONE;
282 if (request->state == GTK_CUPS_REQUEST_DONE)
284 request->poll_state = GTK_CUPS_HTTP_IDLE;
288 /* We need to recheck using httpCheck if the poll_state is read, because
289 * Cups has an internal read buffer. And if this buffer is filled, we may
290 * never get a poll event again. */
291 while (request->poll_state == GTK_CUPS_HTTP_READ && request->http && httpCheck(request->http));
297 gtk_cups_request_get_poll_state (GtkCupsRequest *request)
299 return request->poll_state;
305 gtk_cups_request_get_result (GtkCupsRequest *request)
307 return request->result;
311 gtk_cups_request_ipp_add_string (GtkCupsRequest *request,
318 ippAddString (request->ipp_request,
327 gtk_cups_request_ipp_add_strings (GtkCupsRequest *request,
333 const char *const *values)
335 ippAddStrings (request->ipp_request,
345 gtk_cups_request_ipp_get_string (GtkCupsRequest *request,
349 ipp_attribute_t *attribute = NULL;
351 if (request != NULL && request->ipp_request != NULL)
352 attribute = ippFindAttribute (request->ipp_request,
356 if (attribute != NULL && attribute->values != NULL)
357 return attribute->values[0].string.text;
369 static const ipp_option_t ipp_options[] = {
370 { "blackplot", IPP_TAG_BOOLEAN },
371 { "brightness", IPP_TAG_INTEGER },
372 { "columns", IPP_TAG_INTEGER },
373 { "copies", IPP_TAG_INTEGER },
374 { "finishings", IPP_TAG_ENUM },
375 { "fitplot", IPP_TAG_BOOLEAN },
376 { "gamma", IPP_TAG_INTEGER },
377 { "hue", IPP_TAG_INTEGER },
378 { "job-k-limit", IPP_TAG_INTEGER },
379 { "job-page-limit", IPP_TAG_INTEGER },
380 { "job-priority", IPP_TAG_INTEGER },
381 { "job-quota-period", IPP_TAG_INTEGER },
382 { "landscape", IPP_TAG_BOOLEAN },
383 { "media", IPP_TAG_KEYWORD },
384 { "mirror", IPP_TAG_BOOLEAN },
385 { "natural-scaling", IPP_TAG_INTEGER },
386 { "number-up", IPP_TAG_INTEGER },
387 { "orientation-requested", IPP_TAG_ENUM },
388 { "page-bottom", IPP_TAG_INTEGER },
389 { "page-left", IPP_TAG_INTEGER },
390 { "page-ranges", IPP_TAG_RANGE },
391 { "page-right", IPP_TAG_INTEGER },
392 { "page-top", IPP_TAG_INTEGER },
393 { "penwidth", IPP_TAG_INTEGER },
394 { "ppi", IPP_TAG_INTEGER },
395 { "prettyprint", IPP_TAG_BOOLEAN },
396 { "printer-resolution", IPP_TAG_RESOLUTION },
397 { "print-quality", IPP_TAG_ENUM },
398 { "saturation", IPP_TAG_INTEGER },
399 { "scaling", IPP_TAG_INTEGER },
400 { "sides", IPP_TAG_KEYWORD },
401 { "wrap", IPP_TAG_BOOLEAN },
402 { "number-up-layout", IPP_TAG_INTEGER }
407 _find_option_tag (const gchar *option)
409 int lower_bound, upper_bound, num_options;
413 result = IPP_TAG_ZERO;
416 upper_bound = num_options = (int) G_N_ELEMENTS (ipp_options) - 1;
421 current_option = (int) (((upper_bound - lower_bound) / 2) + lower_bound);
423 match = strcasecmp (option, ipp_options[current_option].name);
426 result = ipp_options[current_option].value_tag;
431 upper_bound = current_option - 1;
435 lower_bound = current_option + 1;
438 if (upper_bound == lower_bound && upper_bound == current_option)
444 if (lower_bound > num_options)
447 if (upper_bound < lower_bound)
453 * Note that this function uses IPP_TAG_JOB, so it is
454 * only suitable for IPP Group 2 attributes.
458 gtk_cups_request_encode_option (GtkCupsRequest *request,
462 ipp_tag_t option_tag;
464 g_return_if_fail (option != NULL);
465 g_return_if_fail (value != NULL);
467 option_tag = _find_option_tag (option);
469 if (option_tag == IPP_TAG_ZERO)
471 option_tag = IPP_TAG_NAME;
472 if (strcasecmp (value, "true") == 0 ||
473 strcasecmp (value, "false") == 0)
475 option_tag = IPP_TAG_BOOLEAN;
481 case IPP_TAG_INTEGER:
483 ippAddInteger (request->ipp_request,
487 strtol (value, NULL, 0));
490 case IPP_TAG_BOOLEAN:
494 if (strcasecmp (value, "true") == 0 ||
495 strcasecmp (value, "on") == 0 ||
496 strcasecmp (value, "yes") == 0)
501 ippAddBoolean (request->ipp_request,
521 lower = strtol (value, &s, 0);
526 upper = strtol (s + 1, NULL, 0);
533 ippAddRange (request->ipp_request,
542 case IPP_TAG_RESOLUTION:
549 xres = strtol (value, &s, 0);
552 yres = strtol (s + 1, &s, 0);
556 if (strcasecmp (s, "dpc") == 0)
557 units = IPP_RES_PER_CM;
559 units = IPP_RES_PER_INCH;
561 ippAddResolution (request->ipp_request,
579 values = g_strdup (value);
583 for (s = values, next = s; *s != '\0'; s++)
585 if (in_quotes != 2 && *s == '\'')
587 /* skip quoted value */
593 else if (in_quotes != 1 && *s == '\"')
595 /* skip quoted value */
601 else if (in_quotes == 0 && *s == ',')
603 /* found delimiter, add to value array */
606 strings = g_ptr_array_new ();
607 g_ptr_array_add (strings, next);
610 else if (in_quotes == 0 && *s == '\\' && s[1] != '\0')
612 /* skip escaped character */
620 ippAddString (request->ipp_request,
629 /* multiple values */
632 g_ptr_array_add (strings, next);
634 ippAddStrings (request->ipp_request,
640 (const char **) strings->pdata);
641 g_ptr_array_free (strings, TRUE);
653 _connect (GtkCupsRequest *request)
655 request->poll_state = GTK_CUPS_HTTP_IDLE;
656 request->bytes_received = 0;
658 if (request->http == NULL)
660 request->http = httpConnectEncrypt (request->server,
664 if (request->http == NULL)
668 httpBlocking (request->http, 0);
670 request->own_http = TRUE;
674 request->attempts = 0;
677 /* we always write to the socket after we get
679 request->poll_state = GTK_CUPS_HTTP_WRITE;
684 _post_send (GtkCupsRequest *request)
687 struct stat data_info;
690 g_print ("CUPS Backend: %s\n", G_STRFUNC));
692 request->poll_state = GTK_CUPS_HTTP_WRITE;
694 if (request->data_io != NULL)
696 fstat (g_io_channel_unix_get_fd (request->data_io), &data_info);
697 sprintf (length, "%lu", (unsigned long) (ippLength (request->ipp_request) + data_info.st_size));
700 sprintf (length, "%lu", (unsigned long) ippLength (request->ipp_request));
702 httpClearFields (request->http);
703 httpSetField (request->http, HTTP_FIELD_CONTENT_LENGTH, length);
704 httpSetField (request->http, HTTP_FIELD_CONTENT_TYPE, "application/ipp");
705 #ifdef HAVE_HTTPGETAUTHSTRING
706 httpSetField (request->http, HTTP_FIELD_AUTHORIZATION, httpGetAuthString (request->http));
708 #ifdef HAVE_HTTP_AUTHSTRING
709 httpSetField (request->http, HTTP_FIELD_AUTHORIZATION, request->http->authstring);
713 if (httpPost (request->http, request->resource))
715 if (httpReconnect (request->http))
717 request->state = GTK_CUPS_POST_DONE;
718 request->poll_state = GTK_CUPS_HTTP_IDLE;
720 /* TODO: should add a status or error code for failed post */
721 gtk_cups_result_set_error (request->result,
722 GTK_CUPS_ERROR_GENERAL,
732 request->attempts = 0;
734 request->state = GTK_CUPS_POST_WRITE_REQUEST;
735 request->ipp_request->state = IPP_IDLE;
739 _post_write_request (GtkCupsRequest *request)
741 ipp_state_t ipp_status;
744 g_print ("CUPS Backend: %s\n", G_STRFUNC));
746 request->poll_state = GTK_CUPS_HTTP_WRITE;
748 ipp_status = ippWrite (request->http, request->ipp_request);
750 if (ipp_status == IPP_ERROR)
752 int cups_error = cupsLastError ();
753 request->state = GTK_CUPS_POST_DONE;
754 request->poll_state = GTK_CUPS_HTTP_IDLE;
756 gtk_cups_result_set_error (request->result,
761 ippErrorString (cups_error));
765 if (ipp_status == IPP_DATA)
767 if (request->data_io != NULL)
768 request->state = GTK_CUPS_POST_WRITE_DATA;
771 request->state = GTK_CUPS_POST_CHECK;
772 request->poll_state = GTK_CUPS_HTTP_READ;
778 _post_write_data (GtkCupsRequest *request)
781 char buffer[_GTK_CUPS_MAX_CHUNK_SIZE];
782 http_status_t http_status;
785 g_print ("CUPS Backend: %s\n", G_STRFUNC));
787 request->poll_state = GTK_CUPS_HTTP_WRITE;
789 if (httpCheck (request->http))
790 http_status = httpUpdate (request->http);
792 http_status = request->last_status;
794 request->last_status = http_status;
797 if (http_status == HTTP_CONTINUE || http_status == HTTP_OK)
806 g_io_channel_read_chars (request->data_io,
808 _GTK_CUPS_MAX_CHUNK_SIZE,
812 if (io_status == G_IO_STATUS_ERROR)
814 request->state = GTK_CUPS_POST_DONE;
815 request->poll_state = GTK_CUPS_HTTP_IDLE;
817 gtk_cups_result_set_error (request->result,
821 "Error reading from cache file: %s",
824 g_error_free (error);
827 else if (bytes == 0 && io_status == G_IO_STATUS_EOF)
829 request->state = GTK_CUPS_POST_CHECK;
830 request->poll_state = GTK_CUPS_HTTP_READ;
832 request->attempts = 0;
837 if (httpWrite2 (request->http, buffer, bytes) < bytes)
841 http_errno = httpError (request->http);
843 request->state = GTK_CUPS_POST_DONE;
844 request->poll_state = GTK_CUPS_HTTP_IDLE;
846 gtk_cups_result_set_error (request->result,
850 "Error writing to socket in Post %s",
851 g_strerror (http_errno));
855 else if (http_status == HTTP_UNAUTHORIZED)
857 request->state = GTK_CUPS_POST_CHECK;
858 request->poll_state = GTK_CUPS_HTTP_READ;
860 request->attempts = 0;
870 _post_auth (GtkCupsRequest *request)
872 if (request->password_state == GTK_CUPS_PASSWORD_HAS)
874 if (request->password == NULL)
876 request->state = GTK_CUPS_POST_DONE;
877 request->poll_state = GTK_CUPS_HTTP_IDLE;
879 gtk_cups_result_set_error (request->result,
886 request->state = GTK_CUPS_POST_CHECK;
891 _get_auth (GtkCupsRequest *request)
893 if (request->password_state == GTK_CUPS_PASSWORD_HAS)
895 if (request->password == NULL)
897 request->state = GTK_CUPS_GET_DONE;
898 request->poll_state = GTK_CUPS_HTTP_IDLE;
900 gtk_cups_result_set_error (request->result,
907 request->state = GTK_CUPS_GET_CHECK;
911 /* Very ugly hack: cups has a stupid synchronous password callback
912 * that doesn't even take the request or user data parameters, so
913 * we have to use a static variable to pass the password to it.
915 * The callback sets cups_password to NULL to signal that the
916 * password has been used.
918 static char *cups_password = NULL;
919 static char *cups_username = NULL;
922 passwordCB (const char *prompt)
924 char *pwd = cups_password;
925 cups_password = NULL;
927 cupsSetUser (cups_username);
933 _post_check (GtkCupsRequest *request)
935 http_status_t http_status;
937 http_status = request->last_status;
940 g_print ("CUPS Backend: %s - status %i\n", G_STRFUNC, http_status));
942 request->poll_state = GTK_CUPS_HTTP_READ;
944 if (http_status == HTTP_CONTINUE)
948 else if (http_status == HTTP_UNAUTHORIZED)
950 int auth_result = -1;
951 httpFlush (request->http);
953 if (request->password_state == GTK_CUPS_PASSWORD_APPLIED)
955 request->poll_state = GTK_CUPS_HTTP_IDLE;
956 request->password_state = GTK_CUPS_PASSWORD_NOT_VALID;
957 request->state = GTK_CUPS_POST_AUTH;
958 request->need_password = TRUE;
964 if (strncmp (httpGetField (request->http, HTTP_FIELD_WWW_AUTHENTICATE), "Negotiate", 9) == 0)
966 auth_result = cupsDoAuthentication (request->http, "POST", request->resource);
968 /* Basic, BasicDigest, Digest and PeerCred */
971 if (request->password_state == GTK_CUPS_PASSWORD_NONE)
973 cups_username = request->username;
974 cupsSetPasswordCB (passwordCB);
976 /* This call success for PeerCred authentication */
977 auth_result = cupsDoAuthentication (request->http, "POST", request->resource);
979 if (auth_result != 0)
981 /* move to AUTH state to let the backend
984 request->poll_state = GTK_CUPS_HTTP_IDLE;
985 request->state = GTK_CUPS_POST_AUTH;
986 request->need_password = TRUE;
993 cups_password = request->password;
994 cups_username = request->username;
996 auth_result = cupsDoAuthentication (request->http, "POST", request->resource);
998 if (cups_password != NULL)
1001 if (request->password != NULL)
1003 memset (request->password, 0, strlen (request->password));
1004 g_free (request->password);
1005 request->password = NULL;
1008 request->password_state = GTK_CUPS_PASSWORD_APPLIED;
1013 httpReconnect (request->http))
1015 /* if the password has been used, reset password_state
1016 * so that we ask for a new one next time around
1018 if (cups_password == NULL)
1019 request->password_state = GTK_CUPS_PASSWORD_NONE;
1021 request->state = GTK_CUPS_POST_DONE;
1022 request->poll_state = GTK_CUPS_HTTP_IDLE;
1023 gtk_cups_result_set_error (request->result,
1024 GTK_CUPS_ERROR_AUTH,
1031 if (request->data_io != NULL)
1032 g_io_channel_seek_position (request->data_io, 0, G_SEEK_SET, NULL);
1034 request->state = GTK_CUPS_POST_CONNECT;
1035 request->poll_state = GTK_CUPS_HTTP_WRITE;
1037 else if (http_status == HTTP_ERROR)
1039 int error = httpError (request->http);
1041 if (error != WSAENETDOWN && error != WSAENETUNREACH)
1043 if (error != ENETDOWN && error != ENETUNREACH)
1044 #endif /* G_OS_WIN32 */
1046 request->attempts++;
1051 request->state = GTK_CUPS_POST_DONE;
1052 request->poll_state = GTK_CUPS_HTTP_IDLE;
1054 gtk_cups_result_set_error (request->result,
1055 GTK_CUPS_ERROR_HTTP,
1058 "Unknown HTTP error");
1063 else if (http_status == HTTP_UPGRADE_REQUIRED)
1065 /* Flush any error message... */
1066 httpFlush (request->http);
1068 cupsSetEncryption (HTTP_ENCRYPT_REQUIRED);
1069 request->state = GTK_CUPS_POST_CONNECT;
1072 httpReconnect (request->http);
1074 /* Upgrade with encryption... */
1075 httpEncryption (request->http, HTTP_ENCRYPT_REQUIRED);
1077 request->attempts++;
1080 else if (http_status != HTTP_OK)
1084 http_errno = httpError (request->http);
1086 if (http_errno == EPIPE)
1087 request->state = GTK_CUPS_POST_CONNECT;
1090 request->state = GTK_CUPS_POST_DONE;
1091 gtk_cups_result_set_error (request->result,
1092 GTK_CUPS_ERROR_HTTP,
1095 "HTTP Error in POST %s",
1096 g_strerror (http_errno));
1097 request->poll_state = GTK_CUPS_HTTP_IDLE;
1099 httpFlush (request->http);
1103 request->poll_state = GTK_CUPS_HTTP_IDLE;
1105 httpFlush (request->http);
1107 request->last_status = HTTP_CONTINUE;
1108 httpClose (request->http);
1109 request->http = NULL;
1114 request->state = GTK_CUPS_POST_READ_RESPONSE;
1119 http_status = HTTP_CONTINUE;
1121 if (httpCheck (request->http))
1122 http_status = httpUpdate (request->http);
1124 request->last_status = http_status;
1128 _post_read_response (GtkCupsRequest *request)
1130 ipp_state_t ipp_status;
1133 g_print ("CUPS Backend: %s\n", G_STRFUNC));
1135 request->poll_state = GTK_CUPS_HTTP_READ;
1137 if (request->result->ipp_response == NULL)
1138 request->result->ipp_response = ippNew();
1140 ipp_status = ippRead (request->http,
1141 request->result->ipp_response);
1143 if (ipp_status == IPP_ERROR)
1145 int ipp_error = cupsLastError ();
1146 gtk_cups_result_set_error (request->result,
1151 ippErrorString (ipp_error));
1153 ippDelete (request->result->ipp_response);
1154 request->result->ipp_response = NULL;
1156 request->state = GTK_CUPS_POST_DONE;
1157 request->poll_state = GTK_CUPS_HTTP_IDLE;
1159 else if (ipp_status == IPP_DATA)
1161 request->state = GTK_CUPS_POST_DONE;
1162 request->poll_state = GTK_CUPS_HTTP_IDLE;
1167 _get_send (GtkCupsRequest *request)
1170 g_print ("CUPS Backend: %s\n", G_STRFUNC));
1172 request->poll_state = GTK_CUPS_HTTP_WRITE;
1174 if (request->data_io == NULL)
1176 gtk_cups_result_set_error (request->result,
1179 G_IO_CHANNEL_ERROR_FAILED,
1180 "Get requires an open io channel");
1182 request->state = GTK_CUPS_GET_DONE;
1183 request->poll_state = GTK_CUPS_HTTP_IDLE;
1188 httpClearFields (request->http);
1189 #ifdef HAVE_HTTPGETAUTHSTRING
1190 httpSetField (request->http, HTTP_FIELD_AUTHORIZATION, httpGetAuthString (request->http));
1192 #ifdef HAVE_HTTP_AUTHSTRING
1193 httpSetField (request->http, HTTP_FIELD_AUTHORIZATION, request->http->authstring);
1197 if (httpGet (request->http, request->resource))
1199 if (httpReconnect (request->http))
1201 request->state = GTK_CUPS_GET_DONE;
1202 request->poll_state = GTK_CUPS_HTTP_IDLE;
1204 /* TODO: should add a status or error code for failed GET */
1205 gtk_cups_result_set_error (request->result,
1206 GTK_CUPS_ERROR_GENERAL,
1212 request->attempts++;
1216 if (httpCheck (request->http))
1217 request->last_status = httpUpdate (request->http);
1219 request->attempts = 0;
1221 request->state = GTK_CUPS_GET_CHECK;
1222 request->poll_state = GTK_CUPS_HTTP_READ;
1224 request->ipp_request->state = IPP_IDLE;
1228 _get_check (GtkCupsRequest *request)
1230 http_status_t http_status;
1233 g_print ("CUPS Backend: %s\n", G_STRFUNC));
1235 http_status = request->last_status;
1237 request->poll_state = GTK_CUPS_HTTP_READ;
1239 if (http_status == HTTP_CONTINUE)
1243 else if (http_status == HTTP_UNAUTHORIZED)
1245 int auth_result = -1;
1246 httpFlush (request->http);
1248 if (request->password_state == GTK_CUPS_PASSWORD_APPLIED)
1250 request->poll_state = GTK_CUPS_HTTP_IDLE;
1251 request->password_state = GTK_CUPS_PASSWORD_NOT_VALID;
1252 request->state = GTK_CUPS_GET_AUTH;
1253 request->need_password = TRUE;
1259 if (strncmp (httpGetField (request->http, HTTP_FIELD_WWW_AUTHENTICATE), "Negotiate", 9) == 0)
1261 auth_result = cupsDoAuthentication (request->http, "GET", request->resource);
1263 /* Basic, BasicDigest, Digest and PeerCred */
1266 if (request->password_state == GTK_CUPS_PASSWORD_NONE)
1268 cups_username = request->username;
1269 cupsSetPasswordCB (passwordCB);
1271 /* This call success for PeerCred authentication */
1272 auth_result = cupsDoAuthentication (request->http, "GET", request->resource);
1274 if (auth_result != 0)
1276 /* move to AUTH state to let the backend
1277 * ask for a password
1279 request->poll_state = GTK_CUPS_HTTP_IDLE;
1280 request->state = GTK_CUPS_GET_AUTH;
1281 request->need_password = TRUE;
1288 cups_password = request->password;
1289 cups_username = request->username;
1291 auth_result = cupsDoAuthentication (request->http, "GET", request->resource);
1293 if (cups_password != NULL)
1296 if (request->password != NULL)
1298 memset (request->password, 0, strlen (request->password));
1299 g_free (request->password);
1300 request->password = NULL;
1303 request->password_state = GTK_CUPS_PASSWORD_APPLIED;
1308 httpReconnect (request->http))
1310 /* if the password has been used, reset password_state
1311 * so that we ask for a new one next time around
1313 if (cups_password == NULL)
1314 request->password_state = GTK_CUPS_PASSWORD_NONE;
1316 request->state = GTK_CUPS_GET_DONE;
1317 request->poll_state = GTK_CUPS_HTTP_IDLE;
1318 gtk_cups_result_set_error (request->result,
1319 GTK_CUPS_ERROR_AUTH,
1326 request->state = GTK_CUPS_GET_CONNECT;
1327 request->last_status = HTTP_CONTINUE;
1331 else if (http_status == HTTP_UPGRADE_REQUIRED)
1333 /* Flush any error message... */
1334 httpFlush (request->http);
1336 cupsSetEncryption (HTTP_ENCRYPT_REQUIRED);
1337 request->state = GTK_CUPS_GET_CONNECT;
1340 httpReconnect (request->http);
1342 /* Upgrade with encryption... */
1343 httpEncryption (request->http, HTTP_ENCRYPT_REQUIRED);
1345 request->attempts++;
1348 else if (http_status != HTTP_OK)
1352 http_errno = httpError (request->http);
1354 if (http_errno == EPIPE)
1355 request->state = GTK_CUPS_GET_CONNECT;
1358 request->state = GTK_CUPS_GET_DONE;
1359 gtk_cups_result_set_error (request->result,
1360 GTK_CUPS_ERROR_HTTP,
1363 "HTTP Error in GET %s",
1364 g_strerror (http_errno));
1365 request->poll_state = GTK_CUPS_HTTP_IDLE;
1366 httpFlush (request->http);
1371 request->poll_state = GTK_CUPS_HTTP_IDLE;
1372 httpFlush (request->http);
1373 httpClose (request->http);
1374 request->last_status = HTTP_CONTINUE;
1375 request->http = NULL;
1381 request->state = GTK_CUPS_GET_READ_DATA;
1386 http_status = HTTP_CONTINUE;
1388 if (httpCheck (request->http))
1389 http_status = httpUpdate (request->http);
1391 request->last_status = http_status;
1396 _get_read_data (GtkCupsRequest *request)
1398 char buffer[_GTK_CUPS_MAX_CHUNK_SIZE];
1400 gsize bytes_written;
1401 GIOStatus io_status;
1405 g_print ("CUPS Backend: %s\n", G_STRFUNC));
1409 request->poll_state = GTK_CUPS_HTTP_READ;
1411 bytes = httpRead2 (request->http, buffer, sizeof (buffer));
1412 request->bytes_received += bytes;
1415 g_print ("CUPS Backend: %"G_GSIZE_FORMAT" bytes read\n", bytes));
1418 g_io_channel_write_chars (request->data_io,
1424 if (io_status == G_IO_STATUS_ERROR)
1426 request->state = GTK_CUPS_GET_DONE;
1427 request->poll_state = GTK_CUPS_HTTP_IDLE;
1429 gtk_cups_result_set_error (request->result,
1434 g_error_free (error);
1437 /* Stop if we do not expect any more data or EOF was received. */
1438 if (httpGetLength2 (request->http) <= request->bytes_received || bytes == 0)
1440 request->state = GTK_CUPS_GET_DONE;
1441 request->poll_state = GTK_CUPS_HTTP_IDLE;
1448 gtk_cups_request_is_done (GtkCupsRequest *request)
1450 return (request->state == GTK_CUPS_REQUEST_DONE);
1454 gtk_cups_result_is_error (GtkCupsResult *result)
1456 return result->is_error;
1460 gtk_cups_result_get_response (GtkCupsResult *result)
1462 return result->ipp_response;
1466 gtk_cups_result_get_error_type (GtkCupsResult *result)
1468 return result->error_type;
1472 gtk_cups_result_get_error_status (GtkCupsResult *result)
1474 return result->error_status;
1478 gtk_cups_result_get_error_code (GtkCupsResult *result)
1480 return result->error_code;
1484 gtk_cups_result_get_error_string (GtkCupsResult *result)
1486 return result->error_msg;
1489 /* This function allocates new instance of GtkCupsConnectionTest() and creates
1490 * a socket for communication with a CUPS server 'server'.
1492 GtkCupsConnectionTest *
1493 gtk_cups_connection_test_new (const char *server)
1495 GtkCupsConnectionTest *result = NULL;
1496 gchar *port_str = NULL;
1498 result = g_new (GtkCupsConnectionTest, 1);
1500 port_str = g_strdup_printf ("%d", ippPort ());
1503 result->addrlist = httpAddrGetList (server, AF_UNSPEC, port_str);
1505 result->addrlist = httpAddrGetList (cupsServer (), AF_UNSPEC, port_str);
1509 result->socket = -1;
1510 result->current_addr = NULL;
1511 result->last_wrong_addr = NULL;
1512 result->at_init = GTK_CUPS_CONNECTION_NOT_AVAILABLE;
1514 result->at_init = gtk_cups_connection_test_get_state (result);
1520 /* A non-blocking test whether it is possible to connect to a CUPS server specified
1521 * inside of GtkCupsConnectionTest structure.
1522 * - you need to check it more then once.
1523 * The connection is closed after a successful connection.
1525 GtkCupsConnectionState
1526 gtk_cups_connection_test_get_state (GtkCupsConnectionTest *test)
1528 GtkCupsConnectionState result = GTK_CUPS_CONNECTION_NOT_AVAILABLE;
1529 http_addrlist_t *iter;
1535 return GTK_CUPS_CONNECTION_NOT_AVAILABLE;
1537 if (test->at_init == GTK_CUPS_CONNECTION_AVAILABLE)
1539 test->at_init = GTK_CUPS_CONNECTION_NOT_AVAILABLE;
1540 return GTK_CUPS_CONNECTION_AVAILABLE;
1544 if (test->socket == -1)
1546 if (test->last_wrong_addr != NULL && test->last_wrong_addr->next != NULL)
1547 iter = test->last_wrong_addr->next;
1550 test->last_wrong_addr = NULL;
1551 iter = test->addrlist;
1556 test->socket = socket (iter->addr.addr.sa_family,
1560 if (test->socket >= 0)
1562 flags = fcntl (test->socket, F_GETFL);
1565 flags |= O_NONBLOCK;
1567 fcntl (test->socket, F_SETFL, flags);
1569 test->current_addr = iter;
1577 if (test->socket >= 0)
1579 code = connect (test->socket,
1580 &test->current_addr->addr.addr,
1581 httpAddrLength (&test->current_addr->addr));
1585 if (code == 0 || error_code == EISCONN)
1587 close (test->socket);
1589 test->current_addr = NULL;
1590 result = GTK_CUPS_CONNECTION_AVAILABLE;
1594 if (error_code == EALREADY || error_code == EINPROGRESS)
1595 result = GTK_CUPS_CONNECTION_IN_PROGRESS;
1598 close (test->socket);
1600 test->last_wrong_addr = test->current_addr;
1601 result = GTK_CUPS_CONNECTION_NOT_AVAILABLE;
1610 /* This function frees memory used by the GtkCupsConnectionTest structure.
1613 gtk_cups_connection_test_free (GtkCupsConnectionTest *test)
1618 test->current_addr = NULL;
1619 test->last_wrong_addr = NULL;
1620 httpAddrFreeList (test->addrlist);
1621 if (test->socket != -1)
1623 close (test->socket);