1 /* GTK - The GIMP Toolkit
2 * gtkprintbackendcups.h: Default implementation of GtkPrintBackend
3 * for the Common Unix Print System (CUPS)
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/>.
27 #include <sys/types.h>
31 /* Cups 1.6 deprecates ppdFindAttr(), ppdFindCustomOption(),
32 * ppdFirstCustomParam(), and ppdNextCustomParam() among others. This
33 * turns off the warning so that it will compile.
35 #ifdef HAVE_CUPS_API_1_6
36 # define _PPD_DEPRECATED
39 #include <cups/cups.h>
40 #include <cups/language.h>
41 #include <cups/http.h>
45 #include <cairo-pdf.h>
48 #include <glib/gstdio.h>
49 #include <glib/gi18n-lib.h>
53 #include <gtk/gtkprintbackend.h>
54 #include <gtk/gtkunixprint.h>
55 #include <gtk/gtkprinter-private.h>
57 #include "gtkprintbackendcups.h"
58 #include "gtkprintercups.h"
60 #include "gtkcupsutils.h"
66 typedef struct _GtkPrintBackendCupsClass GtkPrintBackendCupsClass;
68 #define GTK_PRINT_BACKEND_CUPS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_BACKEND_CUPS, GtkPrintBackendCupsClass))
69 #define GTK_IS_PRINT_BACKEND_CUPS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_BACKEND_CUPS))
70 #define GTK_PRINT_BACKEND_CUPS_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_BACKEND_CUPS, GtkPrintBackendCupsClass))
72 #define _CUPS_MAX_ATTEMPTS 10
73 #define _CUPS_MAX_CHUNK_SIZE 8192
75 /* define this to see warnings about ignored ppd options */
76 #undef PRINT_IGNORED_OPTIONS
78 #define _CUPS_MAP_ATTR_INT(attr, v, a) {if (!g_ascii_strcasecmp (attr->name, (a))) v = attr->values[0].integer;}
79 #define _CUPS_MAP_ATTR_STR(attr, v, a) {if (!g_ascii_strcasecmp (attr->name, (a))) v = attr->values[0].string.text;}
81 static GType print_backend_cups_type = 0;
83 typedef void (* GtkPrintCupsResponseCallbackFunc) (GtkPrintBackend *print_backend,
84 GtkCupsResult *result,
95 } GtkPrintCupsDispatchState;
102 GtkCupsRequest *request;
103 GtkCupsPollState poll_state;
105 GtkPrintBackendCups *backend;
106 GtkPrintCupsResponseCallbackFunc callback;
107 gpointer callback_data;
109 } GtkPrintCupsDispatchWatch;
111 struct _GtkPrintBackendCupsClass
113 GtkPrintBackendClass parent_class;
116 struct _GtkPrintBackendCups
118 GtkPrintBackend parent_instance;
120 char *default_printer;
122 guint list_printers_poll;
123 guint list_printers_pending : 1;
124 gint list_printers_attempts;
125 guint got_default_printer : 1;
126 guint default_printer_poll;
127 GtkCupsConnectionTest *cups_connection_test;
131 int number_of_covers;
136 gboolean authentication_lock;
138 CdClient *colord_client;
142 static GObjectClass *backend_parent_class;
144 static void gtk_print_backend_cups_class_init (GtkPrintBackendCupsClass *class);
145 static void gtk_print_backend_cups_init (GtkPrintBackendCups *impl);
146 static void gtk_print_backend_cups_finalize (GObject *object);
147 static void gtk_print_backend_cups_dispose (GObject *object);
148 static void cups_get_printer_list (GtkPrintBackend *print_backend);
149 static void cups_get_default_printer (GtkPrintBackendCups *print_backend);
150 static void cups_get_local_default_printer (GtkPrintBackendCups *print_backend);
151 static void cups_request_execute (GtkPrintBackendCups *print_backend,
152 GtkCupsRequest *request,
153 GtkPrintCupsResponseCallbackFunc callback,
155 GDestroyNotify notify);
156 static void cups_printer_get_settings_from_options (GtkPrinter *printer,
157 GtkPrinterOptionSet *options,
158 GtkPrintSettings *settings);
159 static gboolean cups_printer_mark_conflicts (GtkPrinter *printer,
160 GtkPrinterOptionSet *options);
161 static GtkPrinterOptionSet *cups_printer_get_options (GtkPrinter *printer,
162 GtkPrintSettings *settings,
163 GtkPageSetup *page_setup,
164 GtkPrintCapabilities capabilities);
165 static void cups_printer_prepare_for_print (GtkPrinter *printer,
166 GtkPrintJob *print_job,
167 GtkPrintSettings *settings,
168 GtkPageSetup *page_setup);
169 static GList * cups_printer_list_papers (GtkPrinter *printer);
170 static GtkPageSetup * cups_printer_get_default_page_size (GtkPrinter *printer);
171 static void cups_printer_request_details (GtkPrinter *printer);
172 static gboolean cups_request_default_printer (GtkPrintBackendCups *print_backend);
173 static gboolean cups_request_ppd (GtkPrinter *printer);
174 static gboolean cups_printer_get_hard_margins (GtkPrinter *printer,
179 static GtkPrintCapabilities cups_printer_get_capabilities (GtkPrinter *printer);
180 static void set_option_from_settings (GtkPrinterOption *option,
181 GtkPrintSettings *setting);
182 static void cups_begin_polling_info (GtkPrintBackendCups *print_backend,
185 static gboolean cups_job_info_poll_timeout (gpointer user_data);
186 static void gtk_print_backend_cups_print_stream (GtkPrintBackend *backend,
189 GtkPrintJobCompleteFunc callback,
191 GDestroyNotify dnotify);
192 static cairo_surface_t * cups_printer_create_cairo_surface (GtkPrinter *printer,
193 GtkPrintSettings *settings,
196 GIOChannel *cache_io);
198 static void gtk_print_backend_cups_set_password (GtkPrintBackend *backend,
199 gchar **auth_info_required,
202 void overwrite_and_free (gpointer data);
203 static gboolean is_address_local (const gchar *address);
204 static gboolean request_auth_info (gpointer data);
207 gtk_print_backend_cups_register_type (GTypeModule *module)
209 const GTypeInfo print_backend_cups_info =
211 sizeof (GtkPrintBackendCupsClass),
212 NULL, /* base_init */
213 NULL, /* base_finalize */
214 (GClassInitFunc) gtk_print_backend_cups_class_init,
215 NULL, /* class_finalize */
216 NULL, /* class_data */
217 sizeof (GtkPrintBackendCups),
219 (GInstanceInitFunc) gtk_print_backend_cups_init
222 print_backend_cups_type = g_type_module_register_type (module,
223 GTK_TYPE_PRINT_BACKEND,
224 "GtkPrintBackendCups",
225 &print_backend_cups_info, 0);
229 pb_module_init (GTypeModule *module)
232 g_print ("CUPS Backend: Initializing the CUPS print backend module\n"));
234 gtk_print_backend_cups_register_type (module);
235 gtk_printer_cups_register_type (module);
239 pb_module_exit (void)
244 G_MODULE_EXPORT GtkPrintBackend *
245 pb_module_create (void)
247 return gtk_print_backend_cups_new ();
249 /* CUPS 1.6 Getter/Setter Functions CUPS 1.6 makes private most of the
250 * IPP structures and enforces access via new getter functions, which
251 * are unfortunately not available in earlier versions. We define
252 * below those getter functions as macros for use when building
253 * against earlier CUPS versions.
255 #ifndef HAVE_CUPS_API_1_6
256 #define ippGetOperation(ipp_request) ipp_request->request.op.operation_id
257 #define ippGetInteger(attr, index) attr->values[index].integer
258 #define ippGetBoolean(attr, index) attr->values[index].boolean
259 #define ippGetString(attr, index, foo) attr->values[index].string.text
260 #define ippGetValueTag(attr) attr->value_tag
261 #define ippGetName(attr) attr->name
262 #define ippGetCount(attr) attr->num_values
263 #define ippGetGroupTag(attr) attr->group_tag
266 * GtkPrintBackendCups
269 gtk_print_backend_cups_get_type (void)
271 return print_backend_cups_type;
275 * gtk_print_backend_cups_new:
277 * Creates a new #GtkPrintBackendCups object. #GtkPrintBackendCups
278 * implements the #GtkPrintBackend interface with direct access to
279 * the filesystem using Unix/Linux API calls
281 * Return value: the new #GtkPrintBackendCups object
284 gtk_print_backend_cups_new (void)
287 g_print ("CUPS Backend: Creating a new CUPS print backend object\n"));
289 return g_object_new (GTK_TYPE_PRINT_BACKEND_CUPS, NULL);
293 gtk_print_backend_cups_class_init (GtkPrintBackendCupsClass *class)
295 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
296 GtkPrintBackendClass *backend_class = GTK_PRINT_BACKEND_CLASS (class);
298 backend_parent_class = g_type_class_peek_parent (class);
300 gobject_class->finalize = gtk_print_backend_cups_finalize;
301 gobject_class->dispose = gtk_print_backend_cups_dispose;
303 backend_class->request_printer_list = cups_get_printer_list;
304 backend_class->print_stream = gtk_print_backend_cups_print_stream;
305 backend_class->printer_request_details = cups_printer_request_details;
306 backend_class->printer_create_cairo_surface = cups_printer_create_cairo_surface;
307 backend_class->printer_get_options = cups_printer_get_options;
308 backend_class->printer_mark_conflicts = cups_printer_mark_conflicts;
309 backend_class->printer_get_settings_from_options = cups_printer_get_settings_from_options;
310 backend_class->printer_prepare_for_print = cups_printer_prepare_for_print;
311 backend_class->printer_list_papers = cups_printer_list_papers;
312 backend_class->printer_get_default_page_size = cups_printer_get_default_page_size;
313 backend_class->printer_get_hard_margins = cups_printer_get_hard_margins;
314 backend_class->printer_get_capabilities = cups_printer_get_capabilities;
315 backend_class->set_password = gtk_print_backend_cups_set_password;
318 static cairo_status_t
319 _cairo_write_to_cups (void *closure,
320 const unsigned char *data,
323 GIOChannel *io = (GIOChannel *)closure;
330 g_print ("CUPS Backend: Writing %i byte chunk to temp file\n", length));
334 g_io_channel_write_chars (io, (gchar *)data, length, &written, &error);
339 g_print ("CUPS Backend: Error writing to temp file, %s\n",
342 g_error_free (error);
343 return CAIRO_STATUS_WRITE_ERROR;
347 g_print ("CUPS Backend: Wrote %"G_GSIZE_FORMAT" bytes to temp file\n", written));
353 return CAIRO_STATUS_SUCCESS;
356 static cairo_surface_t *
357 cups_printer_create_cairo_surface (GtkPrinter *printer,
358 GtkPrintSettings *settings,
361 GIOChannel *cache_io)
363 cairo_surface_t *surface;
364 ppd_file_t *ppd_file = NULL;
365 ppd_attr_t *ppd_attr = NULL;
366 ppd_attr_t *ppd_attr_res = NULL;
367 ppd_attr_t *ppd_attr_screen_freq = NULL;
368 ppd_attr_t *ppd_attr_res_screen_freq = NULL;
369 gchar *res_string = NULL;
372 if (gtk_printer_accepts_pdf (printer))
373 surface = cairo_pdf_surface_create_for_stream (_cairo_write_to_cups, cache_io, width, height);
375 surface = cairo_ps_surface_create_for_stream (_cairo_write_to_cups, cache_io, width, height);
377 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
379 if (ppd_file != NULL)
381 ppd_attr = ppdFindAttr (ppd_file, "LanguageLevel", NULL);
383 if (ppd_attr != NULL)
384 level = atoi (ppd_attr->value);
386 if (gtk_print_settings_get_resolution (settings) == 0)
388 ppd_attr_res = ppdFindAttr (ppd_file, "DefaultResolution", NULL);
390 if (ppd_attr_res != NULL)
392 int res, res_x, res_y;
394 if (sscanf (ppd_attr_res->value, "%dx%ddpi", &res_x, &res_y) == 2)
396 if (res_x > 0 && res_y > 0)
397 gtk_print_settings_set_resolution_xy (settings, res_x, res_y);
399 else if (sscanf (ppd_attr_res->value, "%ddpi", &res) == 1)
402 gtk_print_settings_set_resolution (settings, res);
407 res_string = g_strdup_printf ("%ddpi",
408 gtk_print_settings_get_resolution (settings));
409 ppd_attr_res_screen_freq = ppdFindAttr (ppd_file, "ResScreenFreq", res_string);
412 if (ppd_attr_res_screen_freq == NULL)
414 res_string = g_strdup_printf ("%dx%ddpi",
415 gtk_print_settings_get_resolution_x (settings),
416 gtk_print_settings_get_resolution_y (settings));
417 ppd_attr_res_screen_freq = ppdFindAttr (ppd_file, "ResScreenFreq", res_string);
421 ppd_attr_screen_freq = ppdFindAttr (ppd_file, "ScreenFreq", NULL);
423 if (ppd_attr_res_screen_freq != NULL && atof (ppd_attr_res_screen_freq->value) > 0.0)
424 gtk_print_settings_set_printer_lpi (settings, atof (ppd_attr_res_screen_freq->value));
425 else if (ppd_attr_screen_freq != NULL && atof (ppd_attr_screen_freq->value) > 0.0)
426 gtk_print_settings_set_printer_lpi (settings, atof (ppd_attr_screen_freq->value));
429 if (cairo_surface_get_type (surface) == CAIRO_SURFACE_TYPE_PS)
432 cairo_ps_surface_restrict_to_level (surface, CAIRO_PS_LEVEL_2);
435 cairo_ps_surface_restrict_to_level (surface, CAIRO_PS_LEVEL_3);
438 cairo_surface_set_fallback_resolution (surface,
439 2.0 * gtk_print_settings_get_printer_lpi (settings),
440 2.0 * gtk_print_settings_get_printer_lpi (settings));
446 GtkPrintJobCompleteFunc callback;
449 GDestroyNotify dnotify;
450 } CupsPrintStreamData;
453 cups_free_print_stream_data (CupsPrintStreamData *data)
456 g_print ("CUPS Backend: %s\n", G_STRFUNC));
459 data->dnotify (data->user_data);
460 g_object_unref (data->job);
465 cups_print_cb (GtkPrintBackendCups *print_backend,
466 GtkCupsResult *result,
469 GError *error = NULL;
470 CupsPrintStreamData *ps = user_data;
472 GDK_THREADS_ENTER ();
475 g_print ("CUPS Backend: %s\n", G_STRFUNC));
477 if (gtk_cups_result_is_error (result))
478 error = g_error_new_literal (gtk_print_error_quark (),
479 GTK_PRINT_ERROR_INTERNAL_ERROR,
480 gtk_cups_result_get_error_string (result));
483 ps->callback (ps->job, ps->user_data, error);
488 ipp_attribute_t *attr; /* IPP job-id attribute */
489 ipp_t *response = gtk_cups_result_get_response (result);
491 if ((attr = ippFindAttribute (response, "job-id", IPP_TAG_INTEGER)) != NULL)
492 job_id = ippGetInteger (attr, 0);
494 if (!gtk_print_job_get_track_print_status (ps->job) || job_id == 0)
495 gtk_print_job_set_status (ps->job, GTK_PRINT_STATUS_FINISHED);
498 gtk_print_job_set_status (ps->job, GTK_PRINT_STATUS_PENDING);
499 cups_begin_polling_info (print_backend, ps->job, job_id);
503 gtk_print_job_set_status (ps->job, GTK_PRINT_STATUS_FINISHED_ABORTED);
507 g_error_free (error);
509 GDK_THREADS_LEAVE ();
513 GtkCupsRequest *request;
514 GtkPrinterCups *printer;
518 add_cups_options (const gchar *key,
522 CupsOptionsData *data = (CupsOptionsData *) user_data;
523 GtkCupsRequest *request = data->request;
524 GtkPrinterCups *printer = data->printer;
525 gboolean custom_value = FALSE;
526 gchar *new_value = NULL;
532 if (!g_str_has_prefix (key, "cups-"))
535 if (strcmp (value, "gtk-ignore-value") == 0)
538 key = key + strlen ("cups-");
540 if (printer && printer->ppd_file)
542 ppd_coption_t *coption;
543 gboolean found = FALSE;
544 gboolean custom_values_enabled = FALSE;
546 coption = ppdFindCustomOption (printer->ppd_file, key);
547 if (coption && coption->option)
549 for (i = 0; i < coption->option->num_choices; i++)
551 /* Are custom values enabled ? */
552 if (g_str_equal (coption->option->choices[i].choice, "Custom"))
553 custom_values_enabled = TRUE;
555 /* Is the value among available choices ? */
556 if (g_str_equal (coption->option->choices[i].choice, value))
560 if (custom_values_enabled && !found)
565 /* Add "Custom." prefix to custom values. */
568 new_value = g_strdup_printf ("Custom.%s", value);
569 gtk_cups_request_encode_option (request, key, new_value);
573 gtk_cups_request_encode_option (request, key, value);
577 gtk_print_backend_cups_print_stream (GtkPrintBackend *print_backend,
580 GtkPrintJobCompleteFunc callback,
582 GDestroyNotify dnotify)
584 GtkPrinterCups *cups_printer;
585 CupsPrintStreamData *ps;
586 CupsOptionsData *options_data;
587 GtkCupsRequest *request;
588 GtkPrintSettings *settings;
590 char printer_absolute_uri[HTTP_MAX_URI];
593 g_print ("CUPS Backend: %s\n", G_STRFUNC));
595 cups_printer = GTK_PRINTER_CUPS (gtk_print_job_get_printer (job));
596 settings = gtk_print_job_get_settings (job);
598 request = gtk_cups_request_new_with_username (NULL,
603 cups_printer->device_uri,
604 GTK_PRINT_BACKEND_CUPS (print_backend)->username);
606 httpAssembleURIf (HTTP_URI_CODING_ALL,
607 printer_absolute_uri,
608 sizeof (printer_absolute_uri),
614 gtk_printer_get_name (gtk_print_job_get_printer (job)));
616 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION,
617 IPP_TAG_URI, "printer-uri",
618 NULL, printer_absolute_uri);
620 title = gtk_print_job_get_title (job);
622 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION,
623 IPP_TAG_NAME, "job-name",
626 options_data = g_new0 (CupsOptionsData, 1);
627 options_data->request = request;
628 options_data->printer = cups_printer;
629 gtk_print_settings_foreach (settings, add_cups_options, options_data);
630 g_free (options_data);
632 ps = g_new0 (CupsPrintStreamData, 1);
633 ps->callback = callback;
634 ps->user_data = user_data;
635 ps->dnotify = dnotify;
636 ps->job = g_object_ref (job);
638 request->need_auth_info = cups_printer->auth_info_required != NULL;
639 request->auth_info_required = g_strdupv (cups_printer->auth_info_required);
641 cups_request_execute (GTK_PRINT_BACKEND_CUPS (print_backend),
643 (GtkPrintCupsResponseCallbackFunc) cups_print_cb,
645 (GDestroyNotify)cups_free_print_stream_data);
648 void overwrite_and_free (gpointer data)
650 gchar *password = (gchar *) data;
652 if (password != NULL)
654 memset (password, 0, strlen (password));
660 gtk_print_backend_cups_init (GtkPrintBackendCups *backend_cups)
662 backend_cups->list_printers_poll = FALSE;
663 backend_cups->got_default_printer = FALSE;
664 backend_cups->list_printers_pending = FALSE;
665 backend_cups->list_printers_attempts = 0;
666 backend_cups->reading_ppds = 0;
668 backend_cups->requests = NULL;
669 backend_cups->auth = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, overwrite_and_free);
670 backend_cups->authentication_lock = FALSE;
672 backend_cups->covers = NULL;
673 backend_cups->number_of_covers = 0;
675 backend_cups->default_printer_poll = 0;
676 backend_cups->cups_connection_test = NULL;
678 backend_cups->username = NULL;
681 backend_cups->colord_client = cd_client_new ();
684 cups_get_local_default_printer (backend_cups);
688 gtk_print_backend_cups_finalize (GObject *object)
690 GtkPrintBackendCups *backend_cups;
693 g_print ("CUPS Backend: finalizing CUPS backend module\n"));
695 backend_cups = GTK_PRINT_BACKEND_CUPS (object);
697 g_free (backend_cups->default_printer);
698 backend_cups->default_printer = NULL;
700 g_strfreev (backend_cups->covers);
701 backend_cups->number_of_covers = 0;
703 gtk_cups_connection_test_free (backend_cups->cups_connection_test);
704 backend_cups->cups_connection_test = NULL;
706 g_hash_table_destroy (backend_cups->auth);
708 g_free (backend_cups->username);
711 g_object_unref (backend_cups->colord_client);
714 backend_parent_class->finalize (object);
718 gtk_print_backend_cups_dispose (GObject *object)
720 GtkPrintBackendCups *backend_cups;
723 g_print ("CUPS Backend: %s\n", G_STRFUNC));
725 backend_cups = GTK_PRINT_BACKEND_CUPS (object);
727 if (backend_cups->list_printers_poll > 0)
728 g_source_remove (backend_cups->list_printers_poll);
729 backend_cups->list_printers_poll = 0;
730 backend_cups->list_printers_attempts = 0;
732 if (backend_cups->default_printer_poll > 0)
733 g_source_remove (backend_cups->default_printer_poll);
734 backend_cups->default_printer_poll = 0;
736 backend_parent_class->dispose (object);
740 is_address_local (const gchar *address)
742 if (address[0] == '/' ||
743 strcmp (address, "127.0.0.1") == 0 ||
744 strcmp (address, "[::1]") == 0)
751 gtk_print_backend_cups_set_password (GtkPrintBackend *backend,
752 gchar **auth_info_required,
755 GtkPrintBackendCups *cups_backend = GTK_PRINT_BACKEND_CUPS (backend);
757 char dispatch_hostname[HTTP_MAX_URI];
758 gchar *username = NULL;
759 gchar *hostname = NULL;
760 gchar *password = NULL;
764 length = g_strv_length (auth_info_required);
766 if (auth_info != NULL)
767 for (i = 0; i < length; i++)
769 if (g_strcmp0 (auth_info_required[i], "username") == 0)
770 username = g_strdup (auth_info[i]);
771 else if (g_strcmp0 (auth_info_required[i], "hostname") == 0)
772 hostname = g_strdup (auth_info[i]);
773 else if (g_strcmp0 (auth_info_required[i], "password") == 0)
774 password = g_strdup (auth_info[i]);
777 if (hostname != NULL && username != NULL && password != NULL)
779 gchar *key = g_strconcat (username, "@", hostname, NULL);
780 g_hash_table_insert (cups_backend->auth, key, g_strdup (password));
782 g_print ("CUPS backend: storing password for %s\n", key));
785 g_free (cups_backend->username);
786 cups_backend->username = g_strdup (username);
789 for (l = cups_backend->requests; l; l = l->next)
791 GtkPrintCupsDispatchWatch *dispatch = l->data;
793 httpGetHostname (dispatch->request->http, dispatch_hostname, sizeof (dispatch_hostname));
794 if (is_address_local (dispatch_hostname))
795 strcpy (dispatch_hostname, "localhost");
797 if (dispatch->request->need_auth_info)
799 if (auth_info != NULL)
801 dispatch->request->auth_info = g_new0 (gchar *, length + 1);
802 for (i = 0; i < length; i++)
803 dispatch->request->auth_info[i] = g_strdup (auth_info[i]);
805 dispatch->backend->authentication_lock = FALSE;
806 dispatch->request->need_auth_info = FALSE;
808 else if (dispatch->request->password_state == GTK_CUPS_PASSWORD_REQUESTED || auth_info == NULL)
810 overwrite_and_free (dispatch->request->password);
811 dispatch->request->password = g_strdup (password);
812 g_free (dispatch->request->username);
813 dispatch->request->username = g_strdup (username);
814 dispatch->request->password_state = GTK_CUPS_PASSWORD_HAS;
815 dispatch->backend->authentication_lock = FALSE;
821 request_password (gpointer data)
823 GtkPrintCupsDispatchWatch *dispatch = data;
824 const gchar *username;
826 gchar *prompt = NULL;
828 char hostname[HTTP_MAX_URI];
829 gchar **auth_info_required;
830 gchar **auth_info_default;
831 gchar **auth_info_display;
832 gboolean *auth_info_visible;
836 if (dispatch->backend->authentication_lock)
837 return G_SOURCE_REMOVE;
839 httpGetHostname (dispatch->request->http, hostname, sizeof (hostname));
840 if (is_address_local (hostname))
841 strcpy (hostname, "localhost");
843 if (dispatch->backend->username != NULL)
844 username = dispatch->backend->username;
846 username = cupsUser ();
848 auth_info_required = g_new0 (gchar*, length + 1);
849 auth_info_required[0] = g_strdup ("hostname");
850 auth_info_required[1] = g_strdup ("username");
851 auth_info_required[2] = g_strdup ("password");
853 auth_info_default = g_new0 (gchar*, length + 1);
854 auth_info_default[0] = g_strdup (hostname);
855 auth_info_default[1] = g_strdup (username);
857 auth_info_display = g_new0 (gchar*, length + 1);
858 auth_info_display[1] = g_strdup (_("Username:"));
859 auth_info_display[2] = g_strdup (_("Password:"));
861 auth_info_visible = g_new0 (gboolean, length + 1);
862 auth_info_visible[1] = TRUE;
864 key = g_strconcat (username, "@", hostname, NULL);
865 password = g_hash_table_lookup (dispatch->backend->auth, key);
867 if (password && dispatch->request->password_state != GTK_CUPS_PASSWORD_NOT_VALID)
870 g_print ("CUPS backend: using stored password for %s\n", key));
872 overwrite_and_free (dispatch->request->password);
873 dispatch->request->password = g_strdup (password);
874 g_free (dispatch->request->username);
875 dispatch->request->username = g_strdup (username);
876 dispatch->request->password_state = GTK_CUPS_PASSWORD_HAS;
880 const char *job_title = gtk_cups_request_ipp_get_string (dispatch->request, IPP_TAG_NAME, "job-name");
881 const char *printer_uri = gtk_cups_request_ipp_get_string (dispatch->request, IPP_TAG_URI, "printer-uri");
882 char *printer_name = NULL;
884 if (printer_uri != NULL && strrchr (printer_uri, '/') != NULL)
885 printer_name = g_strdup (strrchr (printer_uri, '/') + 1);
887 if (dispatch->request->password_state == GTK_CUPS_PASSWORD_NOT_VALID)
888 g_hash_table_remove (dispatch->backend->auth, key);
890 dispatch->request->password_state = GTK_CUPS_PASSWORD_REQUESTED;
892 dispatch->backend->authentication_lock = TRUE;
894 switch (ippGetOperation (dispatch->request->ipp_request))
897 if (job_title != NULL && printer_name != NULL)
898 prompt = g_strdup_printf ( _("Authentication is required to print document '%s' on printer %s"), job_title, printer_name);
900 prompt = g_strdup_printf ( _("Authentication is required to print a document on %s"), hostname);
902 case IPP_GET_JOB_ATTRIBUTES:
903 if (job_title != NULL)
904 prompt = g_strdup_printf ( _("Authentication is required to get attributes of job '%s'"), job_title);
906 prompt = g_strdup ( _("Authentication is required to get attributes of a job"));
908 case IPP_GET_PRINTER_ATTRIBUTES:
909 if (printer_name != NULL)
910 prompt = g_strdup_printf ( _("Authentication is required to get attributes of printer %s"), printer_name);
912 prompt = g_strdup ( _("Authentication is required to get attributes of a printer"));
914 case CUPS_GET_DEFAULT:
915 prompt = g_strdup_printf ( _("Authentication is required to get default printer of %s"), hostname);
917 case CUPS_GET_PRINTERS:
918 prompt = g_strdup_printf ( _("Authentication is required to get printers from %s"), hostname);
921 /* work around gcc warning about 0 not being a value for this enum */
922 if (ippGetOperation (dispatch->request->ipp_request) == 0)
923 prompt = g_strdup_printf ( _("Authentication is required to get a file from %s"), hostname);
925 prompt = g_strdup_printf ( _("Authentication is required on %s"), hostname);
929 g_free (printer_name);
931 g_signal_emit_by_name (dispatch->backend, "request-password",
932 auth_info_required, auth_info_default, auth_info_display, auth_info_visible, prompt);
937 for (i = 0; i < length; i++)
939 g_free (auth_info_required[i]);
940 g_free (auth_info_default[i]);
941 g_free (auth_info_display[i]);
944 g_free (auth_info_required);
945 g_free (auth_info_default);
946 g_free (auth_info_display);
947 g_free (auth_info_visible);
950 return G_SOURCE_REMOVE;
954 cups_dispatch_add_poll (GSource *source)
956 GtkPrintCupsDispatchWatch *dispatch;
957 GtkCupsPollState poll_state;
959 dispatch = (GtkPrintCupsDispatchWatch *) source;
961 poll_state = gtk_cups_request_get_poll_state (dispatch->request);
963 /* Remove the old source if the poll state changed. */
964 if (poll_state != dispatch->poll_state && dispatch->data_poll != NULL)
966 g_source_remove_poll (source, dispatch->data_poll);
967 g_free (dispatch->data_poll);
968 dispatch->data_poll = NULL;
971 if (dispatch->request->http != NULL)
973 if (dispatch->data_poll == NULL)
975 dispatch->data_poll = g_new0 (GPollFD, 1);
976 dispatch->poll_state = poll_state;
978 if (poll_state == GTK_CUPS_HTTP_READ)
979 dispatch->data_poll->events = G_IO_IN | G_IO_HUP | G_IO_ERR | G_IO_PRI;
980 else if (poll_state == GTK_CUPS_HTTP_WRITE)
981 dispatch->data_poll->events = G_IO_OUT | G_IO_ERR;
983 dispatch->data_poll->events = 0;
985 dispatch->data_poll->fd = httpGetFd (dispatch->request->http);
986 g_source_add_poll (source, dispatch->data_poll);
992 check_auth_info (gpointer user_data)
994 GtkPrintCupsDispatchWatch *dispatch;
995 dispatch = (GtkPrintCupsDispatchWatch *) user_data;
997 if (!dispatch->request->need_auth_info)
999 if (dispatch->request->auth_info == NULL)
1001 dispatch->callback (GTK_PRINT_BACKEND (dispatch->backend),
1002 gtk_cups_request_get_result (dispatch->request),
1003 dispatch->callback_data);
1004 g_source_destroy ((GSource *) dispatch);
1011 length = g_strv_length (dispatch->request->auth_info_required);
1013 gtk_cups_request_ipp_add_strings (dispatch->request,
1019 (const char * const *) dispatch->request->auth_info);
1021 g_source_attach ((GSource *) dispatch, NULL);
1022 g_source_unref ((GSource *) dispatch);
1024 for (i = 0; i < length; i++)
1025 overwrite_and_free (dispatch->request->auth_info[i]);
1026 g_free (dispatch->request->auth_info);
1027 dispatch->request->auth_info = NULL;
1030 return G_SOURCE_REMOVE;
1033 return G_SOURCE_CONTINUE;
1037 request_auth_info (gpointer user_data)
1039 GtkPrintCupsDispatchWatch *dispatch;
1040 const char *job_title;
1041 const char *printer_uri;
1042 gchar *prompt = NULL;
1043 char *printer_name = NULL;
1046 gboolean *auth_info_visible = NULL;
1047 gchar **auth_info_default = NULL;
1048 gchar **auth_info_display = NULL;
1050 dispatch = (GtkPrintCupsDispatchWatch *) user_data;
1052 if (dispatch->backend->authentication_lock)
1055 job_title = gtk_cups_request_ipp_get_string (dispatch->request, IPP_TAG_NAME, "job-name");
1056 printer_uri = gtk_cups_request_ipp_get_string (dispatch->request, IPP_TAG_URI, "printer-uri");
1057 length = g_strv_length (dispatch->request->auth_info_required);
1059 auth_info_visible = g_new0 (gboolean, length);
1060 auth_info_default = g_new0 (gchar *, length + 1);
1061 auth_info_display = g_new0 (gchar *, length + 1);
1063 for (i = 0; i < length; i++)
1065 if (g_strcmp0 (dispatch->request->auth_info_required[i], "domain") == 0)
1067 auth_info_display[i] = g_strdup (_("Domain:"));
1068 auth_info_default[i] = g_strdup ("WORKGROUP");
1069 auth_info_visible[i] = TRUE;
1071 else if (g_strcmp0 (dispatch->request->auth_info_required[i], "username") == 0)
1073 auth_info_display[i] = g_strdup (_("Username:"));
1074 if (dispatch->backend->username != NULL)
1075 auth_info_default[i] = g_strdup (dispatch->backend->username);
1077 auth_info_default[i] = g_strdup (cupsUser ());
1078 auth_info_visible[i] = TRUE;
1080 else if (g_strcmp0 (dispatch->request->auth_info_required[i], "password") == 0)
1082 auth_info_display[i] = g_strdup (_("Password:"));
1083 auth_info_visible[i] = FALSE;
1087 if (printer_uri != NULL && strrchr (printer_uri, '/') != NULL)
1088 printer_name = g_strdup (strrchr (printer_uri, '/') + 1);
1090 dispatch->backend->authentication_lock = TRUE;
1092 if (job_title != NULL)
1094 if (printer_name != NULL)
1095 prompt = g_strdup_printf ( _("Authentication is required to print document '%s' on printer %s"), job_title, printer_name);
1097 prompt = g_strdup_printf ( _("Authentication is required to print document '%s'"), job_title);
1101 if (printer_name != NULL)
1102 prompt = g_strdup_printf ( _("Authentication is required to print this document on printer %s"), printer_name);
1104 prompt = g_strdup ( _("Authentication is required to print this document"));
1107 g_signal_emit_by_name (dispatch->backend, "request-password",
1108 dispatch->request->auth_info_required,
1114 for (i = 0; i < length; i++)
1116 g_free (auth_info_default[i]);
1117 g_free (auth_info_display[i]);
1120 g_free (auth_info_default);
1121 g_free (auth_info_display);
1122 g_free (printer_name);
1125 g_idle_add (check_auth_info, user_data);
1131 cups_dispatch_watch_check (GSource *source)
1133 GtkPrintCupsDispatchWatch *dispatch;
1134 GtkCupsPollState poll_state;
1138 g_print ("CUPS Backend: %s <source %p>\n", G_STRFUNC, source));
1140 dispatch = (GtkPrintCupsDispatchWatch *) source;
1142 poll_state = gtk_cups_request_get_poll_state (dispatch->request);
1144 if (poll_state != GTK_CUPS_HTTP_IDLE && !dispatch->request->need_password)
1145 if (!(dispatch->data_poll->revents & dispatch->data_poll->events))
1148 result = gtk_cups_request_read_write (dispatch->request, FALSE);
1149 if (result && dispatch->data_poll != NULL)
1151 g_source_remove_poll (source, dispatch->data_poll);
1152 g_free (dispatch->data_poll);
1153 dispatch->data_poll = NULL;
1156 if (dispatch->request->need_password && dispatch->request->password_state != GTK_CUPS_PASSWORD_REQUESTED)
1158 dispatch->request->need_password = FALSE;
1159 g_idle_add (request_password, dispatch);
1167 cups_dispatch_watch_prepare (GSource *source,
1170 GtkPrintCupsDispatchWatch *dispatch;
1173 dispatch = (GtkPrintCupsDispatchWatch *) source;
1176 g_print ("CUPS Backend: %s <source %p>\n", G_STRFUNC, source));
1180 result = gtk_cups_request_read_write (dispatch->request, TRUE);
1182 cups_dispatch_add_poll (source);
1188 cups_dispatch_watch_dispatch (GSource *source,
1189 GSourceFunc callback,
1192 GtkPrintCupsDispatchWatch *dispatch;
1193 GtkPrintCupsResponseCallbackFunc ep_callback;
1194 GtkCupsResult *result;
1196 g_assert (callback != NULL);
1198 ep_callback = (GtkPrintCupsResponseCallbackFunc) callback;
1200 dispatch = (GtkPrintCupsDispatchWatch *) source;
1202 result = gtk_cups_request_get_result (dispatch->request);
1205 g_print ("CUPS Backend: %s <source %p>\n", G_STRFUNC, source));
1207 if (gtk_cups_result_is_error (result))
1210 g_print("Error result: %s (type %i, status %i, code %i)\n",
1211 gtk_cups_result_get_error_string (result),
1212 gtk_cups_result_get_error_type (result),
1213 gtk_cups_result_get_error_status (result),
1214 gtk_cups_result_get_error_code (result)));
1217 ep_callback (GTK_PRINT_BACKEND (dispatch->backend), result, user_data);
1223 cups_dispatch_watch_finalize (GSource *source)
1225 GtkPrintCupsDispatchWatch *dispatch;
1226 GtkCupsResult *result;
1229 g_print ("CUPS Backend: %s <source %p>\n", G_STRFUNC, source));
1231 dispatch = (GtkPrintCupsDispatchWatch *) source;
1233 result = gtk_cups_request_get_result (dispatch->request);
1234 if (gtk_cups_result_get_error_type (result) == GTK_CUPS_ERROR_AUTH)
1236 const gchar *username;
1237 gchar hostname[HTTP_MAX_URI];
1240 httpGetHostname (dispatch->request->http, hostname, sizeof (hostname));
1241 if (is_address_local (hostname))
1242 strcpy (hostname, "localhost");
1244 if (dispatch->backend->username != NULL)
1245 username = dispatch->backend->username;
1247 username = cupsUser ();
1249 key = g_strconcat (username, "@", hostname, NULL);
1251 g_print ("CUPS backend: removing stored password for %s\n", key));
1252 g_hash_table_remove (dispatch->backend->auth, key);
1255 if (dispatch->backend)
1256 dispatch->backend->authentication_lock = FALSE;
1259 gtk_cups_request_free (dispatch->request);
1261 if (dispatch->backend)
1263 /* We need to unref this at idle time, because it might be the
1264 * last reference to this module causing the code to be
1265 * unloaded (including this particular function!)
1266 * Update: Doing this at idle caused a deadlock taking the
1267 * mainloop context lock while being in a GSource callout for
1268 * multithreaded apps. So, for now we just disable unloading
1269 * of print backends. See _gtk_print_backend_create for the
1273 dispatch->backend->requests = g_list_remove (dispatch->backend->requests, dispatch);
1276 g_object_unref (dispatch->backend);
1277 dispatch->backend = NULL;
1280 if (dispatch->data_poll)
1282 g_source_remove_poll (source, dispatch->data_poll);
1283 g_free (dispatch->data_poll);
1284 dispatch->data_poll = NULL;
1288 static GSourceFuncs _cups_dispatch_watch_funcs = {
1289 cups_dispatch_watch_prepare,
1290 cups_dispatch_watch_check,
1291 cups_dispatch_watch_dispatch,
1292 cups_dispatch_watch_finalize
1297 cups_request_execute (GtkPrintBackendCups *print_backend,
1298 GtkCupsRequest *request,
1299 GtkPrintCupsResponseCallbackFunc callback,
1301 GDestroyNotify notify)
1303 GtkPrintCupsDispatchWatch *dispatch;
1305 dispatch = (GtkPrintCupsDispatchWatch *) g_source_new (&_cups_dispatch_watch_funcs,
1306 sizeof (GtkPrintCupsDispatchWatch));
1307 g_source_set_name (&dispatch->source, "GTK+ CUPS backend");
1310 g_print ("CUPS Backend: %s <source %p> - Executing cups request on server '%s' and resource '%s'\n", G_STRFUNC, dispatch, request->server, request->resource));
1312 dispatch->request = request;
1313 dispatch->backend = g_object_ref (print_backend);
1314 dispatch->poll_state = GTK_CUPS_HTTP_IDLE;
1315 dispatch->data_poll = NULL;
1316 dispatch->callback = NULL;
1317 dispatch->callback_data = NULL;
1319 print_backend->requests = g_list_prepend (print_backend->requests, dispatch);
1321 g_source_set_callback ((GSource *) dispatch, (GSourceFunc) callback, user_data, notify);
1323 if (request->need_auth_info)
1325 dispatch->callback = callback;
1326 dispatch->callback_data = user_data;
1327 request_auth_info (dispatch);
1331 g_source_attach ((GSource *) dispatch, NULL);
1332 g_source_unref ((GSource *) dispatch);
1338 cups_request_printer_info_cb (GtkPrintBackendCups *backend,
1339 GtkCupsResult *result,
1342 ipp_attribute_t *attr;
1344 gchar *printer_name;
1345 GtkPrinterCups *cups_printer;
1346 GtkPrinter *printer;
1351 gboolean status_changed;
1353 g_assert (GTK_IS_PRINT_BACKEND_CUPS (backend));
1355 printer_name = (gchar *)user_data;
1356 printer = gtk_print_backend_find_printer (GTK_PRINT_BACKEND (backend),
1360 g_print ("CUPS Backend: %s - Got printer info for printer '%s'\n", G_STRFUNC, printer_name));
1365 g_print ("CUPS Backend: Could not find printer called '%s'\n", printer_name));
1369 cups_printer = GTK_PRINTER_CUPS (printer);
1371 if (gtk_cups_result_is_error (result))
1373 if (gtk_printer_is_new (printer))
1375 gtk_print_backend_remove_printer (GTK_PRINT_BACKEND (backend),
1380 return; /* TODO: mark as inactive printer */
1383 response = gtk_cups_result_get_response (result);
1385 /* TODO: determine printer type and use correct icon */
1386 gtk_printer_set_icon_name (printer, "printer");
1392 for (attr = response->attrs; attr != NULL; attr = attr->next)
1397 _CUPS_MAP_ATTR_STR (attr, loc, "printer-location");
1398 _CUPS_MAP_ATTR_STR (attr, desc, "printer-info");
1399 _CUPS_MAP_ATTR_STR (attr, state_msg, "printer-state-message");
1400 _CUPS_MAP_ATTR_INT (attr, cups_printer->state, "printer-state");
1401 _CUPS_MAP_ATTR_INT (attr, job_count, "queued-job-count");
1404 status_changed = gtk_printer_set_job_count (printer, job_count);
1406 status_changed |= gtk_printer_set_location (printer, loc);
1407 status_changed |= gtk_printer_set_description (printer, desc);
1408 status_changed |= gtk_printer_set_state_message (printer, state_msg);
1411 g_signal_emit_by_name (GTK_PRINT_BACKEND (backend),
1412 "printer-status-changed", printer);
1416 cups_request_printer_info (GtkPrintBackendCups *print_backend,
1417 const gchar *printer_name)
1419 GtkCupsRequest *request;
1421 static const char * const pattrs[] = /* Attributes we're interested in */
1425 "printer-state-message",
1428 "job-sheets-supported",
1429 "job-sheets-default"
1432 request = gtk_cups_request_new_with_username (NULL,
1434 IPP_GET_PRINTER_ATTRIBUTES,
1438 print_backend->username);
1440 printer_uri = g_strdup_printf ("ipp://localhost/printers/%s",
1442 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION, IPP_TAG_URI,
1443 "printer-uri", NULL, printer_uri);
1446 g_print ("CUPS Backend: %s - Requesting printer info for URI '%s'\n", G_STRFUNC, printer_uri));
1448 g_free (printer_uri);
1450 gtk_cups_request_ipp_add_strings (request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
1451 "requested-attributes", G_N_ELEMENTS (pattrs),
1454 cups_request_execute (print_backend,
1456 (GtkPrintCupsResponseCallbackFunc) cups_request_printer_info_cb,
1457 g_strdup (printer_name),
1458 (GDestroyNotify) g_free);
1463 GtkPrintBackendCups *print_backend;
1470 job_object_died (gpointer user_data,
1471 GObject *where_the_object_was)
1473 CupsJobPollData *data = user_data;
1478 cups_job_poll_data_free (CupsJobPollData *data)
1481 g_object_weak_unref (G_OBJECT (data->job), job_object_died, data);
1487 cups_request_job_info_cb (GtkPrintBackendCups *print_backend,
1488 GtkCupsResult *result,
1491 CupsJobPollData *data = user_data;
1492 ipp_attribute_t *attr;
1497 GDK_THREADS_ENTER ();
1499 if (data->job == NULL)
1501 cups_job_poll_data_free (data);
1507 response = gtk_cups_result_get_response (result);
1511 #ifdef HAVE_CUPS_API_1_6
1512 attr = ippFindAttribute (response, "job-state", IPP_TAG_INTEGER);
1513 state = ippGetInteger (attr, 0);
1515 for (attr = response->attrs; attr != NULL; attr = attr->next)
1520 _CUPS_MAP_ATTR_INT (attr, state, "job-state");
1527 case IPP_JOB_PENDING:
1529 case IPP_JOB_STOPPED:
1530 gtk_print_job_set_status (data->job,
1531 GTK_PRINT_STATUS_PENDING);
1533 case IPP_JOB_PROCESSING:
1534 gtk_print_job_set_status (data->job,
1535 GTK_PRINT_STATUS_PRINTING);
1538 case IPP_JOB_CANCELLED:
1539 case IPP_JOB_ABORTED:
1540 gtk_print_job_set_status (data->job,
1541 GTK_PRINT_STATUS_FINISHED_ABORTED);
1545 case IPP_JOB_COMPLETED:
1546 gtk_print_job_set_status (data->job,
1547 GTK_PRINT_STATUS_FINISHED);
1552 if (!done && data->job != NULL)
1556 if (data->counter < 5)
1558 else if (data->counter < 10)
1563 g_timeout_add (timeout, cups_job_info_poll_timeout, data);
1566 cups_job_poll_data_free (data);
1569 GDK_THREADS_LEAVE ();
1573 cups_request_job_info (CupsJobPollData *data)
1575 GtkCupsRequest *request;
1578 request = gtk_cups_request_new_with_username (NULL,
1580 IPP_GET_JOB_ATTRIBUTES,
1584 data->print_backend->username);
1586 job_uri = g_strdup_printf ("ipp://localhost/jobs/%d", data->job_id);
1587 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION, IPP_TAG_URI,
1588 "job-uri", NULL, job_uri);
1591 cups_request_execute (data->print_backend,
1593 (GtkPrintCupsResponseCallbackFunc) cups_request_job_info_cb,
1599 cups_job_info_poll_timeout (gpointer user_data)
1601 CupsJobPollData *data = user_data;
1603 if (data->job == NULL)
1604 cups_job_poll_data_free (data);
1606 cups_request_job_info (data);
1608 return G_SOURCE_REMOVE;
1612 cups_begin_polling_info (GtkPrintBackendCups *print_backend,
1616 CupsJobPollData *data;
1618 data = g_new0 (CupsJobPollData, 1);
1620 data->print_backend = print_backend;
1622 data->job_id = job_id;
1625 g_object_weak_ref (G_OBJECT (job), job_object_died, data);
1627 cups_request_job_info (data);
1631 mark_printer_inactive (GtkPrinter *printer,
1632 GtkPrintBackend *backend)
1634 gtk_printer_set_is_active (printer, FALSE);
1635 g_signal_emit_by_name (backend, "printer-removed", printer);
1639 find_printer (GtkPrinter *printer,
1640 const gchar *find_name)
1642 const gchar *printer_name;
1644 printer_name = gtk_printer_get_name (printer);
1645 return g_ascii_strcasecmp (printer_name, find_name);
1647 /* Printer messages we're interested in */
1648 static const char * const printer_messages[] =
1654 "marker-supply-low",
1655 "marker-supply-empty",
1663 /* Our translatable versions of the printer messages */
1664 static const char * printer_strings[] =
1666 N_("Printer '%s' is low on toner."),
1667 N_("Printer '%s' has no toner left."),
1668 /* Translators: "Developer" like on photo development context */
1669 N_("Printer '%s' is low on developer."),
1670 /* Translators: "Developer" like on photo development context */
1671 N_("Printer '%s' is out of developer."),
1672 /* Translators: "marker" is one color bin of the printer */
1673 N_("Printer '%s' is low on at least one marker supply."),
1674 /* Translators: "marker" is one color bin of the printer */
1675 N_("Printer '%s' is out of at least one marker supply."),
1676 N_("The cover is open on printer '%s'."),
1677 N_("The door is open on printer '%s'."),
1678 N_("Printer '%s' is low on paper."),
1679 N_("Printer '%s' is out of paper."),
1680 N_("Printer '%s' is currently offline."),
1681 N_("There is a problem on printer '%s'.")
1686 GTK_PRINTER_STATE_LEVEL_NONE = 0,
1687 GTK_PRINTER_STATE_LEVEL_INFO = 1,
1688 GTK_PRINTER_STATE_LEVEL_WARNING = 2,
1689 GTK_PRINTER_STATE_LEVEL_ERROR = 3
1690 } PrinterStateLevel;
1694 const gchar *printer_name;
1695 const gchar *printer_uri;
1696 const gchar *member_uris;
1697 const gchar *location;
1698 const gchar *description;
1699 const gchar *state_msg;
1700 const gchar *reason_msg;
1701 PrinterStateLevel reason_level;
1705 gboolean is_accepting_jobs;
1706 const gchar *default_cover_before;
1707 const gchar *default_cover_after;
1708 gboolean default_printer;
1709 gboolean got_printer_type;
1710 gboolean remote_printer;
1711 gchar **auth_info_required;
1712 gint default_number_up;
1716 cups_printer_handle_attribute (GtkPrintBackendCups *cups_backend,
1717 ipp_attribute_t *attr,
1718 PrinterSetupInfo *info)
1721 if (strcmp (ippGetName (attr), "printer-name") == 0 &&
1722 ippGetValueTag (attr) == IPP_TAG_NAME)
1723 info->printer_name = ippGetString (attr, 0, NULL);
1724 else if (strcmp (ippGetName (attr), "printer-uri-supported") == 0 &&
1725 ippGetValueTag (attr) == IPP_TAG_URI)
1726 info->printer_uri = ippGetString (attr, 0, NULL);
1727 else if (strcmp (ippGetName (attr), "member-uris") == 0 &&
1728 ippGetValueTag (attr) == IPP_TAG_URI)
1729 info->member_uris = ippGetString (attr, 0, NULL);
1730 else if (strcmp (ippGetName (attr), "printer-location") == 0)
1731 info->location = ippGetString (attr, 0, NULL);
1732 else if (strcmp (ippGetName (attr), "printer-info") == 0)
1733 info->description = ippGetString (attr, 0, NULL);
1734 else if (strcmp (ippGetName (attr), "printer-state-message") == 0)
1735 info->state_msg = ippGetString (attr, 0, NULL);
1736 else if (strcmp (ippGetName (attr), "printer-state-reasons") == 0)
1737 /* Store most important reason to reason_msg and set
1738 its importance at printer_state_reason_level */
1740 for (i = 0; i < ippGetCount (attr); i++)
1742 if (strcmp (ippGetString (attr, i, NULL), "none") != 0)
1744 gboolean interested_in = FALSE;
1745 /* Sets is_paused flag for paused printer. */
1746 if (strcmp (ippGetString (attr, i, NULL), "paused") == 0)
1748 info->is_paused = TRUE;
1751 for (j = 0; j < G_N_ELEMENTS (printer_messages); j++)
1752 if (strncmp (ippGetString (attr, i, NULL), printer_messages[j],
1753 strlen (printer_messages[j])) == 0)
1755 interested_in = TRUE;
1761 if (g_str_has_suffix (ippGetString (attr, i, NULL), "-report"))
1763 if (info->reason_level <= GTK_PRINTER_STATE_LEVEL_INFO)
1765 info->reason_msg = ippGetString (attr, i, NULL);
1766 info->reason_level = GTK_PRINTER_STATE_LEVEL_INFO;
1769 else if (g_str_has_suffix (ippGetString (attr, i, NULL), "-warning"))
1771 if (info->reason_level <= GTK_PRINTER_STATE_LEVEL_WARNING)
1773 info->reason_msg = ippGetString (attr, i, NULL);
1774 info->reason_level = GTK_PRINTER_STATE_LEVEL_WARNING;
1777 else /* It is error in the case of no suffix. */
1779 info->reason_msg = ippGetString (attr, i, NULL);
1780 info->reason_level = GTK_PRINTER_STATE_LEVEL_ERROR;
1786 else if (strcmp (ippGetName (attr), "printer-state") == 0)
1787 info->state = ippGetInteger (attr, 0);
1788 else if (strcmp (ippGetName (attr), "queued-job-count") == 0)
1789 info->job_count = ippGetInteger (attr, 0);
1790 else if (strcmp (ippGetName (attr), "printer-is-accepting-jobs") == 0)
1792 if (ippGetBoolean (attr, 0) == 1)
1793 info->is_accepting_jobs = TRUE;
1795 info->is_accepting_jobs = FALSE;
1797 else if (strcmp (ippGetName (attr), "job-sheets-supported") == 0)
1799 if (cups_backend->covers == NULL)
1801 cups_backend->number_of_covers = ippGetCount (attr);
1802 cups_backend->covers = g_new (char *, cups_backend->number_of_covers + 1);
1803 for (i = 0; i < cups_backend->number_of_covers; i++)
1804 cups_backend->covers[i] = g_strdup (ippGetString (attr, i, NULL));
1805 cups_backend->covers[cups_backend->number_of_covers] = NULL;
1808 else if (strcmp (ippGetName (attr), "job-sheets-default") == 0)
1810 if (ippGetCount (attr) == 2)
1812 info->default_cover_before = ippGetString (attr, 0, NULL);
1813 info->default_cover_after = ippGetString (attr, 1, NULL);
1816 else if (strcmp (ippGetName (attr), "printer-type") == 0)
1818 info->got_printer_type = TRUE;
1819 if (ippGetInteger (attr, 0) & 0x00020000)
1820 info->default_printer = TRUE;
1822 info->default_printer = FALSE;
1824 if (ippGetInteger (attr, 0) & 0x00000002)
1825 info->remote_printer = TRUE;
1827 info->remote_printer = FALSE;
1829 else if (strcmp (ippGetName (attr), "auth-info-required") == 0)
1831 if (strcmp (ippGetString (attr, 0, NULL), "none") != 0)
1833 info->auth_info_required = g_new0 (gchar *, ippGetCount (attr) + 1);
1834 for (i = 0; i < ippGetCount (attr); i++)
1835 info->auth_info_required[i] = g_strdup (ippGetString (attr, i, NULL));
1838 else if (strcmp (attr->name, "number-up-default") == 0)
1840 info->default_number_up = attr->values[0].integer;
1845 g_print ("CUPS Backend: Attribute %s ignored", ippGetName (attr)));
1850 cups_create_printer (GtkPrintBackendCups *cups_backend,
1851 PrinterSetupInfo *info)
1853 GtkPrinterCups *cups_printer;
1854 GtkPrinter *printer;
1855 GtkPrintBackend *backend = GTK_PRINT_BACKEND (cups_backend);
1856 char uri[HTTP_MAX_URI]; /* Printer URI */
1857 char method[HTTP_MAX_URI]; /* Method/scheme name */
1858 char username[HTTP_MAX_URI]; /* Username:password */
1859 char hostname[HTTP_MAX_URI]; /* Hostname */
1860 char resource[HTTP_MAX_URI]; /* Resource name */
1861 int port; /* Port number */
1862 char *cups_server; /* CUPS server */
1865 cups_printer = gtk_printer_cups_new (info->printer_name,
1867 cups_backend->colord_client);
1869 cups_printer = gtk_printer_cups_new (info->printer_name, backend, NULL);
1872 cups_printer->device_uri = g_strdup_printf ("/printers/%s",
1873 info->printer_name);
1875 /* Check to see if we are looking at a class */
1876 if (info->member_uris)
1878 cups_printer->printer_uri = g_strdup (info->member_uris);
1879 /* TODO if member_uris is a class we need to recursivly find a printer */
1881 g_print ("CUPS Backend: Found class with printer %s\n",
1882 info->member_uris));
1886 cups_printer->printer_uri = g_strdup (info->printer_uri);
1888 g_print ("CUPS Backend: Found printer %s\n",
1889 info->printer_uri));
1892 httpSeparateURI (HTTP_URI_CODING_ALL, cups_printer->printer_uri,
1893 method, sizeof (method),
1894 username, sizeof (username),
1895 hostname, sizeof (hostname),
1897 resource, sizeof (resource));
1899 if (strncmp (resource, "/printers/", 10) == 0)
1901 cups_printer->ppd_name = g_strdup (resource + 10);
1903 g_print ("CUPS Backend: Setting ppd name '%s' for printer/class '%s'\n", cups_printer->ppd_name, printer_name));
1906 gethostname (uri, sizeof (uri));
1907 cups_server = g_strdup (cupsServer());
1909 if (strcasecmp (uri, hostname) == 0)
1910 strcpy (hostname, "localhost");
1912 /* if the cups server is local and listening at a unix domain socket
1913 * then use the socket connection
1915 if ((strstr (hostname, "localhost") != NULL) &&
1916 (cups_server[0] == '/'))
1917 strcpy (hostname, cups_server);
1919 g_free (cups_server);
1921 cups_printer->default_cover_before = g_strdup (info->default_cover_before);
1922 cups_printer->default_cover_after = g_strdup (info->default_cover_after);
1924 cups_printer->default_number_up = info->default_number_up;
1926 cups_printer->hostname = g_strdup (hostname);
1927 cups_printer->port = port;
1929 cups_printer->auth_info_required = g_strdupv (info->auth_info_required);
1930 g_strfreev (info->auth_info_required);
1932 printer = GTK_PRINTER (cups_printer);
1934 if (cups_backend->default_printer != NULL &&
1935 strcmp (cups_backend->default_printer, gtk_printer_get_name (printer)) == 0)
1936 gtk_printer_set_is_default (printer, TRUE);
1939 gtk_print_backend_add_printer (backend, printer);
1945 cups_request_printer_list_cb (GtkPrintBackendCups *cups_backend,
1946 GtkCupsResult *result,
1949 GtkPrintBackend *backend = GTK_PRINT_BACKEND (cups_backend);
1950 ipp_attribute_t *attr;
1952 gboolean list_has_changed;
1953 GList *removed_printer_checklist;
1954 gchar *remote_default_printer = NULL;
1956 GDK_THREADS_ENTER ();
1958 list_has_changed = FALSE;
1961 g_print ("CUPS Backend: %s\n", G_STRFUNC));
1963 cups_backend->list_printers_pending = FALSE;
1965 if (gtk_cups_result_is_error (result))
1968 g_warning ("CUPS Backend: Error getting printer list: %s %d %d",
1969 gtk_cups_result_get_error_string (result),
1970 gtk_cups_result_get_error_type (result),
1971 gtk_cups_result_get_error_code (result)));
1973 if (gtk_cups_result_get_error_type (result) == GTK_CUPS_ERROR_AUTH &&
1974 gtk_cups_result_get_error_code (result) == 1)
1976 /* Canceled by user, stop popping up more password dialogs */
1977 if (cups_backend->list_printers_poll > 0)
1978 g_source_remove (cups_backend->list_printers_poll);
1979 cups_backend->list_printers_poll = 0;
1980 cups_backend->list_printers_attempts = 0;
1986 /* Gather the names of the printers in the current queue
1987 * so we may check to see if they were removed
1989 removed_printer_checklist = gtk_print_backend_get_printer_list (backend);
1991 response = gtk_cups_result_get_response (result);
1992 #ifdef HAVE_CUPS_API_1_6
1993 for (attr = ippFirstAttribute (response); attr != NULL;
1994 attr = ippNextAttribute (response))
1996 GtkPrinter *printer;
1997 gboolean status_changed = FALSE;
2000 PrinterSetupInfo *info = g_slice_new0 (PrinterSetupInfo);
2002 /* Skip leading attributes until we hit a printer...
2004 while (attr != NULL && ippGetGroupTag (attr) != IPP_TAG_PRINTER)
2005 attr = ippNextAttribute (response);
2009 while (attr != NULL && ippGetGroupTag (attr) == IPP_TAG_PRINTER)
2011 cups_printer_handle_attribute (cups_backend, attr, info);
2012 attr = ippNextAttribute (response);
2015 for (attr = response->attrs; attr != NULL; attr = attr->next)
2017 GtkPrinter *printer;
2018 gboolean status_changed = FALSE;
2021 PrinterSetupInfo *info = g_slice_new0 (PrinterSetupInfo);
2022 info->default_number_up = 1;
2024 /* Skip leading attributes until we hit a printer...
2026 while (attr != NULL && ippGetGroupTag (attr) != IPP_TAG_PRINTER)
2031 while (attr != NULL && ippGetGroupTag (attr) == IPP_TAG_PRINTER)
2033 cups_printer_handle_attribute (cups_backend, attr, info);
2038 if (info->printer_name == NULL ||
2039 (info->printer_uri == NULL && info->member_uris == NULL))
2047 if (info->got_printer_type)
2049 if (info->default_printer && !cups_backend->got_default_printer)
2051 if (!info->remote_printer)
2053 cups_backend->got_default_printer = TRUE;
2054 cups_backend->default_printer = g_strdup (info->printer_name);
2058 if (remote_default_printer == NULL)
2059 remote_default_printer = g_strdup (info->printer_name);
2065 if (!cups_backend->got_default_printer)
2066 cups_get_default_printer (cups_backend);
2069 /* remove name from checklist if it was found */
2070 node = g_list_find_custom (removed_printer_checklist,
2072 (GCompareFunc) find_printer);
2073 removed_printer_checklist = g_list_delete_link (removed_printer_checklist,
2076 printer = gtk_print_backend_find_printer (backend, info->printer_name);
2079 printer = cups_create_printer (cups_backend, info);
2080 list_has_changed = TRUE;
2084 g_object_ref (printer);
2086 GTK_PRINTER_CUPS (printer)->remote = info->remote_printer;
2088 gtk_printer_set_is_paused (printer, info->is_paused);
2089 gtk_printer_set_is_accepting_jobs (printer, info->is_accepting_jobs);
2091 if (!gtk_printer_is_active (printer))
2093 gtk_printer_set_is_active (printer, TRUE);
2094 gtk_printer_set_is_new (printer, TRUE);
2095 list_has_changed = TRUE;
2098 if (gtk_printer_is_new (printer))
2100 g_signal_emit_by_name (backend, "printer-added", printer);
2102 gtk_printer_set_is_new (printer, FALSE);
2106 /* Getting printer info with separate requests overwhelms cups
2107 * when the printer list has more than a handful of printers.
2109 cups_request_printer_info (cups_backend, gtk_printer_get_name (printer));
2112 GTK_PRINTER_CUPS (printer)->state = info->state;
2113 status_changed = gtk_printer_set_job_count (printer, info->job_count);
2114 status_changed |= gtk_printer_set_location (printer, info->location);
2115 status_changed |= gtk_printer_set_description (printer,
2118 if (info->state_msg != NULL && strlen (info->state_msg) == 0)
2120 gchar *tmp_msg2 = NULL;
2121 if (info->is_paused && !info->is_accepting_jobs)
2122 /* Translators: this is a printer status. */
2123 tmp_msg2 = g_strdup ( N_("Paused ; Rejecting Jobs"));
2124 if (info->is_paused && info->is_accepting_jobs)
2125 /* Translators: this is a printer status. */
2126 tmp_msg2 = g_strdup ( N_("Paused"));
2127 if (!info->is_paused && !info->is_accepting_jobs)
2128 /* Translators: this is a printer status. */
2129 tmp_msg2 = g_strdup ( N_("Rejecting Jobs"));
2131 if (tmp_msg2 != NULL)
2133 info->state_msg = tmp_msg2;
2138 /* Set description of the reason and combine it with printer-state-message. */
2139 if ( (info->reason_msg != NULL))
2141 gchar *reason_msg_desc = NULL;
2142 gboolean found = FALSE;
2144 for (i = 0; i < G_N_ELEMENTS (printer_messages); i++)
2146 if (strncmp (info->reason_msg, printer_messages[i],
2147 strlen (printer_messages[i])) == 0)
2149 reason_msg_desc = g_strdup_printf (printer_strings[i],
2150 info->printer_name);
2157 info->reason_level = GTK_PRINTER_STATE_LEVEL_NONE;
2159 if (info->reason_level >= GTK_PRINTER_STATE_LEVEL_WARNING)
2161 if (strlen (info->state_msg) == 0)
2162 info->state_msg = reason_msg_desc;
2165 gchar *tmp_msg = NULL;
2166 tmp_msg = g_strjoin (" ; ", info->state_msg,
2167 reason_msg_desc, NULL);
2168 info->state_msg = tmp_msg;
2172 if (reason_msg_desc != NULL)
2173 g_free (reason_msg_desc);
2176 status_changed |= gtk_printer_set_state_message (printer, info->state_msg);
2177 status_changed |= gtk_printer_set_is_accepting_jobs (printer, info->is_accepting_jobs);
2181 /* Set printer icon according to importance
2182 (none, report, warning, error - report is omitted). */
2183 if (info->reason_level == GTK_PRINTER_STATE_LEVEL_ERROR)
2184 gtk_printer_set_icon_name (printer, "printer-error");
2185 else if (info->reason_level == GTK_PRINTER_STATE_LEVEL_WARNING)
2186 gtk_printer_set_icon_name (printer, "printer-warning");
2187 else if (gtk_printer_is_paused (printer))
2188 gtk_printer_set_icon_name (printer, "printer-paused");
2190 gtk_printer_set_icon_name (printer, "printer");
2193 g_signal_emit_by_name (GTK_PRINT_BACKEND (backend),
2194 "printer-status-changed", printer);
2196 /* The ref is held by GtkPrintBackend, in add_printer() */
2197 g_object_unref (printer);
2198 g_slice_free (PrinterSetupInfo, info);
2204 /* look at the removed printers checklist and mark any printer
2205 as inactive if it is in the list, emitting a printer_removed signal */
2206 if (removed_printer_checklist != NULL)
2208 g_list_free_full (removed_printer_checklist, (GDestroyNotify) mark_printer_inactive);
2209 list_has_changed = TRUE;
2213 if (list_has_changed)
2214 g_signal_emit_by_name (backend, "printer-list-changed");
2216 gtk_print_backend_set_list_done (backend);
2218 if (!cups_backend->got_default_printer && remote_default_printer != NULL)
2220 cups_backend->default_printer = g_strdup (remote_default_printer);
2221 cups_backend->got_default_printer = TRUE;
2222 g_free (remote_default_printer);
2224 if (cups_backend->default_printer != NULL)
2226 GtkPrinter *default_printer = NULL;
2227 default_printer = gtk_print_backend_find_printer (GTK_PRINT_BACKEND (cups_backend),
2228 cups_backend->default_printer);
2229 if (default_printer != NULL)
2231 gtk_printer_set_is_default (default_printer, TRUE);
2232 g_signal_emit_by_name (GTK_PRINT_BACKEND (cups_backend),
2233 "printer-status-changed", default_printer);
2238 GDK_THREADS_LEAVE ();
2242 update_backend_status (GtkPrintBackendCups *cups_backend,
2243 GtkCupsConnectionState state)
2247 case GTK_CUPS_CONNECTION_NOT_AVAILABLE:
2248 g_object_set (cups_backend, "status", GTK_PRINT_BACKEND_STATUS_UNAVAILABLE, NULL);
2250 case GTK_CUPS_CONNECTION_AVAILABLE:
2251 g_object_set (cups_backend, "status", GTK_PRINT_BACKEND_STATUS_OK, NULL);
2258 cups_request_printer_list (GtkPrintBackendCups *cups_backend)
2260 GtkCupsConnectionState state;
2261 GtkCupsRequest *request;
2262 static const char * const pattrs[] = /* Attributes we're interested in */
2265 "printer-uri-supported",
2269 "printer-state-message",
2270 "printer-state-reasons",
2273 "printer-is-accepting-jobs",
2274 "job-sheets-supported",
2275 "job-sheets-default",
2277 "auth-info-required",
2281 if (cups_backend->reading_ppds > 0 || cups_backend->list_printers_pending)
2284 state = gtk_cups_connection_test_get_state (cups_backend->cups_connection_test);
2285 update_backend_status (cups_backend, state);
2287 if (cups_backend->list_printers_attempts == 60)
2289 cups_backend->list_printers_attempts = -1;
2290 if (cups_backend->list_printers_poll > 0)
2291 g_source_remove (cups_backend->list_printers_poll);
2292 cups_backend->list_printers_poll = gdk_threads_add_timeout (200,
2293 (GSourceFunc) cups_request_printer_list,
2296 else if (cups_backend->list_printers_attempts != -1)
2297 cups_backend->list_printers_attempts++;
2299 if (state == GTK_CUPS_CONNECTION_IN_PROGRESS || state == GTK_CUPS_CONNECTION_NOT_AVAILABLE)
2302 if (cups_backend->list_printers_attempts > 0)
2303 cups_backend->list_printers_attempts = 60;
2305 cups_backend->list_printers_pending = TRUE;
2307 request = gtk_cups_request_new_with_username (NULL,
2313 cups_backend->username);
2315 gtk_cups_request_ipp_add_strings (request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
2316 "requested-attributes", G_N_ELEMENTS (pattrs),
2319 cups_request_execute (cups_backend,
2321 (GtkPrintCupsResponseCallbackFunc) cups_request_printer_list_cb,
2329 cups_get_printer_list (GtkPrintBackend *backend)
2331 GtkPrintBackendCups *cups_backend;
2333 cups_backend = GTK_PRINT_BACKEND_CUPS (backend);
2335 if (cups_backend->cups_connection_test == NULL)
2336 cups_backend->cups_connection_test = gtk_cups_connection_test_new (NULL);
2338 if (cups_backend->list_printers_poll == 0)
2340 if (cups_request_printer_list (cups_backend))
2341 cups_backend->list_printers_poll = gdk_threads_add_timeout (50,
2342 (GSourceFunc) cups_request_printer_list,
2348 GtkPrinterCups *printer;
2354 get_ppd_data_free (GetPPDData *data)
2357 g_print ("CUPS Backend: %s\n", G_STRFUNC));
2358 httpClose (data->http);
2359 g_io_channel_unref (data->ppd_io);
2360 g_object_unref (data->printer);
2365 cups_request_ppd_cb (GtkPrintBackendCups *print_backend,
2366 GtkCupsResult *result,
2369 GtkPrinter *printer;
2371 GDK_THREADS_ENTER ();
2374 g_print ("CUPS Backend: %s\n", G_STRFUNC));
2376 printer = GTK_PRINTER (data->printer);
2377 GTK_PRINTER_CUPS (printer)->reading_ppd = FALSE;
2378 print_backend->reading_ppds--;
2380 if (gtk_cups_result_is_error (result))
2382 gboolean success = FALSE;
2384 /* if we get a 404 then it is just a raw printer without a ppd
2386 if ((gtk_cups_result_get_error_type (result) == GTK_CUPS_ERROR_HTTP) &&
2387 (gtk_cups_result_get_error_status (result) == HTTP_NOT_FOUND))
2389 gtk_printer_set_has_details (printer, TRUE);
2393 g_signal_emit_by_name (printer, "details-acquired", success);
2397 /* let ppdOpenFd take over the ownership of the open file */
2398 g_io_channel_seek_position (data->ppd_io, 0, G_SEEK_SET, NULL);
2399 data->printer->ppd_file = ppdOpenFd (dup (g_io_channel_unix_get_fd (data->ppd_io)));
2400 ppdLocalize (data->printer->ppd_file);
2401 ppdMarkDefaults (data->printer->ppd_file);
2403 gtk_printer_set_has_details (printer, TRUE);
2404 g_signal_emit_by_name (printer, "details-acquired", TRUE);
2407 GDK_THREADS_LEAVE ();
2411 cups_request_ppd (GtkPrinter *printer)
2414 GtkPrintBackend *print_backend;
2415 GtkPrinterCups *cups_printer;
2416 GtkCupsRequest *request;
2423 cups_printer = GTK_PRINTER_CUPS (printer);
2428 g_print ("CUPS Backend: %s\n", G_STRFUNC));
2430 if (cups_printer->remote)
2432 GtkCupsConnectionState state;
2434 state = gtk_cups_connection_test_get_state (cups_printer->remote_cups_connection_test);
2436 if (state == GTK_CUPS_CONNECTION_IN_PROGRESS)
2438 if (cups_printer->get_remote_ppd_attempts == 60)
2440 cups_printer->get_remote_ppd_attempts = -1;
2441 if (cups_printer->get_remote_ppd_poll > 0)
2442 g_source_remove (cups_printer->get_remote_ppd_poll);
2443 cups_printer->get_remote_ppd_poll = gdk_threads_add_timeout (200,
2444 (GSourceFunc) cups_request_ppd,
2447 else if (cups_printer->get_remote_ppd_attempts != -1)
2448 cups_printer->get_remote_ppd_attempts++;
2453 gtk_cups_connection_test_free (cups_printer->remote_cups_connection_test);
2454 cups_printer->remote_cups_connection_test = NULL;
2455 cups_printer->get_remote_ppd_poll = 0;
2456 cups_printer->get_remote_ppd_attempts = 0;
2458 if (state == GTK_CUPS_CONNECTION_NOT_AVAILABLE)
2460 g_signal_emit_by_name (printer, "details-acquired", FALSE);
2465 http = httpConnectEncrypt (cups_printer->hostname,
2469 data = g_new0 (GetPPDData, 1);
2471 fd = g_file_open_tmp ("gtkprint_ppd_XXXXXX",
2475 #ifdef G_ENABLE_DEBUG
2476 /* If we are debugging printing don't delete the tmp files */
2477 if (!(gtk_get_debug_flags () & GTK_DEBUG_PRINTING))
2478 unlink (ppd_filename);
2480 unlink (ppd_filename);
2481 #endif /* G_ENABLE_DEBUG */
2486 g_warning ("CUPS Backend: Failed to create temp file, %s\n",
2488 g_error_free (error);
2490 g_free (ppd_filename);
2493 g_signal_emit_by_name (printer, "details-acquired", FALSE);
2498 fchmod (fd, S_IRUSR | S_IWUSR);
2499 data->ppd_io = g_io_channel_unix_new (fd);
2500 g_io_channel_set_encoding (data->ppd_io, NULL, NULL);
2501 g_io_channel_set_close_on_unref (data->ppd_io, TRUE);
2503 data->printer = g_object_ref (printer);
2505 resource = g_strdup_printf ("/printers/%s.ppd",
2506 gtk_printer_cups_get_ppd_name (GTK_PRINTER_CUPS (printer)));
2508 print_backend = gtk_printer_get_backend (printer);
2510 request = gtk_cups_request_new_with_username (data->http,
2514 cups_printer->hostname,
2516 GTK_PRINT_BACKEND_CUPS (print_backend)->username);
2519 g_print ("CUPS Backend: Requesting resource %s to be written to temp file %s\n", resource, ppd_filename));
2522 cups_printer->reading_ppd = TRUE;
2523 GTK_PRINT_BACKEND_CUPS (print_backend)->reading_ppds++;
2525 cups_request_execute (GTK_PRINT_BACKEND_CUPS (print_backend),
2527 (GtkPrintCupsResponseCallbackFunc) cups_request_ppd_cb,
2529 (GDestroyNotify)get_ppd_data_free);
2532 g_free (ppd_filename);
2537 /* Ordering matters for default preference */
2538 static const char *lpoptions_locations[] = {
2539 "/etc/cups/lpoptions",
2545 cups_parse_user_default_printer (const char *filename,
2546 char **printer_name)
2549 char line[1024], *lineptr, *defname = NULL;
2551 if ((fp = g_fopen (filename, "r")) == NULL)
2554 while (fgets (line, sizeof (line), fp) != NULL)
2556 if (strncasecmp (line, "default", 7) != 0 || !isspace (line[7]))
2560 while (isspace (*lineptr))
2567 while (!isspace (*lineptr) && *lineptr && *lineptr != '/')
2572 if (*printer_name != NULL)
2573 g_free (*printer_name);
2575 *printer_name = g_strdup (defname);
2582 cups_get_user_default_printer (char **printer_name)
2586 for (i = 0; i < G_N_ELEMENTS (lpoptions_locations); i++)
2588 if (g_path_is_absolute (lpoptions_locations[i]))
2590 cups_parse_user_default_printer (lpoptions_locations[i],
2597 filename = g_build_filename (g_get_home_dir (),
2598 lpoptions_locations[i], NULL);
2599 cups_parse_user_default_printer (filename, printer_name);
2606 cups_parse_user_options (const char *filename,
2607 const char *printer_name,
2609 cups_option_t **options)
2612 gchar line[1024], *lineptr, *name;
2614 if ((fp = g_fopen (filename, "r")) == NULL)
2617 while (fgets (line, sizeof (line), fp) != NULL)
2619 if (strncasecmp (line, "dest", 4) == 0 && isspace (line[4]))
2621 else if (strncasecmp (line, "default", 7) == 0 && isspace (line[7]))
2626 /* Skip leading whitespace */
2627 while (isspace (*lineptr))
2633 /* NUL-terminate the name, stripping the instance name */
2635 while (!isspace (*lineptr) && *lineptr)
2637 if (*lineptr == '/')
2647 if (strncasecmp (name, printer_name, strlen (printer_name)) != 0)
2650 /* We found our printer, parse the options */
2651 num_options = cupsParseOptions (lineptr, num_options, options);
2660 cups_get_user_options (const char *printer_name,
2662 cups_option_t **options)
2666 for (i = 0; i < G_N_ELEMENTS (lpoptions_locations); i++)
2668 if (g_path_is_absolute (lpoptions_locations[i]))
2670 num_options = cups_parse_user_options (lpoptions_locations[i],
2679 filename = g_build_filename (g_get_home_dir (),
2680 lpoptions_locations[i], NULL);
2681 num_options = cups_parse_user_options (filename, printer_name,
2682 num_options, options);
2690 /* This function requests default printer from a CUPS server in regular intervals.
2691 * In the case of unreachable CUPS server the request is repeated later.
2692 * The default printer is not requested in the case of previous success.
2695 cups_get_default_printer (GtkPrintBackendCups *backend)
2697 GtkPrintBackendCups *cups_backend;
2699 cups_backend = backend;
2701 if (cups_backend->cups_connection_test == NULL)
2702 cups_backend->cups_connection_test = gtk_cups_connection_test_new (NULL);
2704 if (cups_backend->default_printer_poll == 0)
2706 if (cups_request_default_printer (cups_backend))
2707 cups_backend->default_printer_poll = gdk_threads_add_timeout (200,
2708 (GSourceFunc) cups_request_default_printer,
2713 /* This function gets default printer from local settings.*/
2715 cups_get_local_default_printer (GtkPrintBackendCups *backend)
2720 if ((str = g_getenv ("LPDEST")) != NULL)
2722 backend->default_printer = g_strdup (str);
2723 backend->got_default_printer = TRUE;
2726 else if ((str = g_getenv ("PRINTER")) != NULL &&
2727 strcmp (str, "lp") != 0)
2729 backend->default_printer = g_strdup (str);
2730 backend->got_default_printer = TRUE;
2734 /* Figure out user setting for default printer */
2735 cups_get_user_default_printer (&name);
2738 backend->default_printer = name;
2739 backend->got_default_printer = TRUE;
2745 cups_request_default_printer_cb (GtkPrintBackendCups *print_backend,
2746 GtkCupsResult *result,
2750 ipp_attribute_t *attr;
2751 GtkPrinter *printer;
2753 GDK_THREADS_ENTER ();
2755 if (gtk_cups_result_is_error (result))
2757 if (gtk_cups_result_get_error_type (result) == GTK_CUPS_ERROR_AUTH &&
2758 gtk_cups_result_get_error_code (result) == 1)
2760 /* Canceled by user, stop popping up more password dialogs */
2761 if (print_backend->list_printers_poll > 0)
2762 g_source_remove (print_backend->list_printers_poll);
2763 print_backend->list_printers_poll = 0;
2769 response = gtk_cups_result_get_response (result);
2771 if ((attr = ippFindAttribute (response, "printer-name", IPP_TAG_NAME)) != NULL)
2772 print_backend->default_printer = g_strdup (ippGetString (attr, 0, NULL));
2774 print_backend->got_default_printer = TRUE;
2776 if (print_backend->default_printer != NULL)
2778 printer = gtk_print_backend_find_printer (GTK_PRINT_BACKEND (print_backend), print_backend->default_printer);
2779 if (printer != NULL)
2781 gtk_printer_set_is_default (printer, TRUE);
2782 g_signal_emit_by_name (GTK_PRINT_BACKEND (print_backend), "printer-status-changed", printer);
2786 /* Make sure to kick off get_printers if we are polling it,
2787 * as we could have blocked this reading the default printer
2789 if (print_backend->list_printers_poll != 0)
2790 cups_request_printer_list (print_backend);
2792 GDK_THREADS_LEAVE ();
2796 cups_request_default_printer (GtkPrintBackendCups *print_backend)
2798 GtkCupsConnectionState state;
2799 GtkCupsRequest *request;
2801 state = gtk_cups_connection_test_get_state (print_backend->cups_connection_test);
2802 update_backend_status (print_backend, state);
2804 if (state == GTK_CUPS_CONNECTION_IN_PROGRESS || state == GTK_CUPS_CONNECTION_NOT_AVAILABLE)
2807 request = gtk_cups_request_new_with_username (NULL,
2813 print_backend->username);
2815 cups_request_execute (print_backend,
2817 (GtkPrintCupsResponseCallbackFunc) cups_request_default_printer_cb,
2818 g_object_ref (print_backend),
2825 cups_printer_request_details (GtkPrinter *printer)
2827 GtkPrinterCups *cups_printer;
2829 cups_printer = GTK_PRINTER_CUPS (printer);
2830 if (!cups_printer->reading_ppd &&
2831 gtk_printer_cups_get_ppd (cups_printer) == NULL)
2833 if (cups_printer->remote)
2835 if (cups_printer->get_remote_ppd_poll == 0)
2837 cups_printer->remote_cups_connection_test = gtk_cups_connection_test_new (cups_printer->hostname);
2839 if (cups_request_ppd (printer))
2840 cups_printer->get_remote_ppd_poll = gdk_threads_add_timeout (50,
2841 (GSourceFunc) cups_request_ppd,
2846 cups_request_ppd (printer);
2851 ppd_text_to_utf8 (ppd_file_t *ppd_file,
2854 const char *encoding = NULL;
2857 if (g_ascii_strcasecmp (ppd_file->lang_encoding, "UTF-8") == 0)
2859 return g_strdup (text);
2861 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "ISOLatin1") == 0)
2863 encoding = "ISO-8859-1";
2865 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "ISOLatin2") == 0)
2867 encoding = "ISO-8859-2";
2869 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "ISOLatin5") == 0)
2871 encoding = "ISO-8859-5";
2873 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "JIS83-RKSJ") == 0)
2875 encoding = "SHIFT-JIS";
2877 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "MacStandard") == 0)
2879 encoding = "MACINTOSH";
2881 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "WindowsANSI") == 0)
2883 encoding = "WINDOWS-1252";
2887 /* Fallback, try iso-8859-1... */
2888 encoding = "ISO-8859-1";
2891 res = g_convert (text, -1, "UTF-8", encoding, NULL, NULL, NULL);
2896 g_warning ("CUPS Backend: Unable to convert PPD text\n"));
2897 res = g_strdup ("???");
2903 /* TODO: Add more translations for common settings here */
2905 static const struct {
2906 const char *keyword;
2907 const char *translation;
2908 } cups_option_translations[] = {
2909 { "Duplex", N_("Two Sided") },
2910 { "MediaType", N_("Paper Type") },
2911 { "InputSlot", N_("Paper Source") },
2912 { "OutputBin", N_("Output Tray") },
2913 { "Resolution", N_("Resolution") },
2914 { "PreFilter", N_("GhostScript pre-filtering") },
2918 static const struct {
2919 const char *keyword;
2921 const char *translation;
2922 } cups_choice_translations[] = {
2923 { "Duplex", "None", N_("One Sided") },
2924 /* Translators: this is an option of "Two Sided" */
2925 { "Duplex", "DuplexNoTumble", N_("Long Edge (Standard)") },
2926 /* Translators: this is an option of "Two Sided" */
2927 { "Duplex", "DuplexTumble", N_("Short Edge (Flip)") },
2928 /* Translators: this is an option of "Paper Source" */
2929 { "InputSlot", "Auto", N_("Auto Select") },
2930 /* Translators: this is an option of "Paper Source" */
2931 { "InputSlot", "AutoSelect", N_("Auto Select") },
2932 /* Translators: this is an option of "Paper Source" */
2933 { "InputSlot", "Default", N_("Printer Default") },
2934 /* Translators: this is an option of "Paper Source" */
2935 { "InputSlot", "None", N_("Printer Default") },
2936 /* Translators: this is an option of "Paper Source" */
2937 { "InputSlot", "PrinterDefault", N_("Printer Default") },
2938 /* Translators: this is an option of "Paper Source" */
2939 { "InputSlot", "Unspecified", N_("Auto Select") },
2940 /* Translators: this is an option of "Resolution" */
2941 { "Resolution", "default", N_("Printer Default") },
2942 /* Translators: this is an option of "GhostScript" */
2943 { "PreFilter", "EmbedFonts", N_("Embed GhostScript fonts only") },
2944 /* Translators: this is an option of "GhostScript" */
2945 { "PreFilter", "Level1", N_("Convert to PS level 1") },
2946 /* Translators: this is an option of "GhostScript" */
2947 { "PreFilter", "Level2", N_("Convert to PS level 2") },
2948 /* Translators: this is an option of "GhostScript" */
2949 { "PreFilter", "No", N_("No pre-filtering") },
2952 static const struct {
2954 const char *translation;
2955 } cups_group_translations[] = {
2956 /* Translators: "Miscellaneous" is the label for a button, that opens
2957 up an extra panel of settings in a print dialog. */
2958 { "Miscellaneous", N_("Miscellaneous") },
2961 static const struct {
2962 const char *ppd_keyword;
2964 } ppd_option_names[] = {
2965 {"Duplex", "gtk-duplex" },
2966 {"MediaType", "gtk-paper-type"},
2967 {"InputSlot", "gtk-paper-source"},
2968 {"OutputBin", "gtk-output-tray"},
2971 static const struct {
2972 const char *lpoption;
2974 } lpoption_names[] = {
2975 {"number-up", "gtk-n-up" },
2976 {"number-up-layout", "gtk-n-up-layout"},
2977 {"job-billing", "gtk-billing-info"},
2978 {"job-priority", "gtk-job-prio"},
2981 /* keep sorted when changing */
2982 static const char *color_option_whitelist[] = {
2983 "BRColorEnhancement",
2989 "BlackSubstitution",
2997 "RPSBlackOverPrint",
3001 /* keep sorted when changing */
3002 static const char *color_group_whitelist[] = {
3009 "HPColorOptionsPanel",
3012 /* keep sorted when changing */
3013 static const char *image_quality_option_whitelist[] = {
3015 "BRHalfTonePattern",
3025 "HPGraphicsHalftone",
3040 /* keep sorted when changing */
3041 static const char *image_quality_group_whitelist[] = {
3048 /* keep sorted when changing */
3049 static const char * finishing_option_whitelist[] = {
3062 "StapleOrientation",
3068 /* keep sorted when changing */
3069 static const char *finishing_group_whitelist[] = {
3078 /* keep sorted when changing */
3079 static const char *cups_option_blacklist[] = {
3088 get_option_text (ppd_file_t *ppd_file,
3089 ppd_option_t *option)
3094 for (i = 0; i < G_N_ELEMENTS (cups_option_translations); i++)
3096 if (strcmp (cups_option_translations[i].keyword, option->keyword) == 0)
3097 return g_strdup (_(cups_option_translations[i].translation));
3100 utf8 = ppd_text_to_utf8 (ppd_file, option->text);
3102 /* Some ppd files have spaces in the text before the colon */
3109 get_choice_text (ppd_file_t *ppd_file,
3110 ppd_choice_t *choice)
3113 ppd_option_t *option = choice->option;
3114 const char *keyword = option->keyword;
3116 for (i = 0; i < G_N_ELEMENTS (cups_choice_translations); i++)
3118 if (strcmp (cups_choice_translations[i].keyword, keyword) == 0 &&
3119 strcmp (cups_choice_translations[i].choice, choice->choice) == 0)
3120 return g_strdup (_(cups_choice_translations[i].translation));
3122 return ppd_text_to_utf8 (ppd_file, choice->text);
3126 group_has_option (ppd_group_t *group,
3127 ppd_option_t *option)
3134 if (group->num_options > 0 &&
3135 option >= group->options && option < group->options + group->num_options)
3138 for (i = 0; i < group->num_subgroups; i++)
3140 if (group_has_option (&group->subgroups[i],option))
3147 set_option_off (GtkPrinterOption *option)
3149 /* Any of these will do, _set only applies the value
3150 * if its allowed of the option */
3151 gtk_printer_option_set (option, "False");
3152 gtk_printer_option_set (option, "Off");
3153 gtk_printer_option_set (option, "None");
3157 value_is_off (const char *value)
3159 return (strcasecmp (value, "None") == 0 ||
3160 strcasecmp (value, "Off") == 0 ||
3161 strcasecmp (value, "False") == 0);
3165 ppd_group_name (ppd_group_t *group)
3171 available_choices (ppd_file_t *ppd,
3172 ppd_option_t *option,
3173 ppd_choice_t ***available,
3174 gboolean keep_if_only_one_option)
3176 ppd_option_t *other_option;
3179 ppd_const_t *constraint;
3180 const char *choice, *other_choice;
3181 ppd_option_t *option1, *option2;
3182 ppd_group_t *installed_options;
3184 gboolean all_default;
3190 conflicts = g_new0 (char, option->num_choices);
3192 installed_options = NULL;
3193 for (i = 0; i < ppd->num_groups; i++)
3197 name = ppd_group_name (&ppd->groups[i]);
3198 if (strcmp (name, "InstallableOptions") == 0)
3200 installed_options = &ppd->groups[i];
3205 for (i = ppd->num_consts, constraint = ppd->consts; i > 0; i--, constraint++)
3207 option1 = ppdFindOption (ppd, constraint->option1);
3208 if (option1 == NULL)
3211 option2 = ppdFindOption (ppd, constraint->option2);
3212 if (option2 == NULL)
3215 if (option == option1)
3217 choice = constraint->choice1;
3218 other_option = option2;
3219 other_choice = constraint->choice2;
3221 else if (option == option2)
3223 choice = constraint->choice2;
3224 other_option = option1;
3225 other_choice = constraint->choice1;
3230 /* We only care of conflicts with installed_options and
3232 if (!group_has_option (installed_options, other_option) &&
3233 (strcmp (other_option->keyword, "PageSize") != 0))
3236 if (*other_choice == 0)
3238 /* Conflict only if the installed option is not off */
3239 if (value_is_off (other_option->defchoice))
3242 /* Conflict if the installed option has the specified default */
3243 else if (strcasecmp (other_choice, other_option->defchoice) != 0)
3248 /* Conflict with all non-off choices */
3249 for (j = 0; j < option->num_choices; j++)
3251 if (!value_is_off (option->choices[j].choice))
3257 for (j = 0; j < option->num_choices; j++)
3259 if (strcasecmp (option->choices[j].choice, choice) == 0)
3267 for (j = 0; j < option->num_choices; j++)
3271 else if (strcmp (option->choices[j].choice, option->defchoice) != 0)
3272 all_default = FALSE;
3275 if ((all_default && !keep_if_only_one_option) ||
3276 (num_conflicts == option->num_choices))
3283 /* Some ppds don't have a "use printer default" option for
3284 * InputSlot. This means you always have to select a particular slot,
3285 * and you can't auto-pick source based on the paper size. To support
3286 * this we always add an auto option if there isn't one already. If
3287 * the user chooses the generated option we don't send any InputSlot
3288 * value when printing. The way we detect existing auto-cases is based
3289 * on feedback from Michael Sweet of cups fame.
3292 if (strcmp (option->keyword, "InputSlot") == 0)
3294 gboolean found_auto = FALSE;
3295 for (j = 0; j < option->num_choices; j++)
3299 if (strcmp (option->choices[j].choice, "Auto") == 0 ||
3300 strcmp (option->choices[j].choice, "AutoSelect") == 0 ||
3301 strcmp (option->choices[j].choice, "Default") == 0 ||
3302 strcmp (option->choices[j].choice, "None") == 0 ||
3303 strcmp (option->choices[j].choice, "PrinterDefault") == 0 ||
3304 strcmp (option->choices[j].choice, "Unspecified") == 0 ||
3305 option->choices[j].code == NULL ||
3306 option->choices[j].code[0] == 0)
3320 *available = g_new (ppd_choice_t *, option->num_choices - num_conflicts + add_auto);
3323 for (j = 0; j < option->num_choices; j++)
3326 (*available)[i++] = &option->choices[j];
3330 (*available)[i++] = NULL;
3335 return option->num_choices - num_conflicts + add_auto;
3338 static GtkPrinterOption *
3339 create_pickone_option (ppd_file_t *ppd_file,
3340 ppd_option_t *ppd_option,
3341 const gchar *gtk_name)
3343 GtkPrinterOption *option;
3344 ppd_choice_t **available;
3348 ppd_coption_t *coption;
3350 g_assert (ppd_option->ui == PPD_UI_PICKONE);
3354 n_choices = available_choices (ppd_file, ppd_option, &available, g_str_has_prefix (gtk_name, "gtk-"));
3358 /* right now only support one parameter per custom option
3359 * if more than one print warning and only offer the default choices
3362 label = get_option_text (ppd_file, ppd_option);
3364 coption = ppdFindCustomOption (ppd_file, ppd_option->keyword);
3368 ppd_cparam_t *cparam;
3370 cparam = ppdFirstCustomParam (coption);
3372 if (ppdNextCustomParam (coption) == NULL)
3374 switch (cparam->type)
3376 case PPD_CUSTOM_INT:
3377 option = gtk_printer_option_new (gtk_name, label,
3378 GTK_PRINTER_OPTION_TYPE_PICKONE_INT);
3380 case PPD_CUSTOM_PASSCODE:
3381 option = gtk_printer_option_new (gtk_name, label,
3382 GTK_PRINTER_OPTION_TYPE_PICKONE_PASSCODE);
3384 case PPD_CUSTOM_PASSWORD:
3385 option = gtk_printer_option_new (gtk_name, label,
3386 GTK_PRINTER_OPTION_TYPE_PICKONE_PASSWORD);
3388 case PPD_CUSTOM_REAL:
3389 option = gtk_printer_option_new (gtk_name, label,
3390 GTK_PRINTER_OPTION_TYPE_PICKONE_REAL);
3392 case PPD_CUSTOM_STRING:
3393 option = gtk_printer_option_new (gtk_name, label,
3394 GTK_PRINTER_OPTION_TYPE_PICKONE_STRING);
3396 #ifdef PRINT_IGNORED_OPTIONS
3397 case PPD_CUSTOM_POINTS:
3398 g_warning ("CUPS Backend: PPD Custom Points Option not supported");
3400 case PPD_CUSTOM_CURVE:
3401 g_warning ("CUPS Backend: PPD Custom Curve Option not supported");
3403 case PPD_CUSTOM_INVCURVE:
3404 g_warning ("CUPS Backend: PPD Custom Inverse Curve Option not supported");
3411 #ifdef PRINT_IGNORED_OPTIONS
3413 g_warning ("CUPS Backend: Multi-parameter PPD Custom Option not supported");
3418 option = gtk_printer_option_new (gtk_name, label,
3419 GTK_PRINTER_OPTION_TYPE_PICKONE);
3422 gtk_printer_option_allocate_choices (option, n_choices);
3423 for (i = 0; i < n_choices; i++)
3425 if (available[i] == NULL)
3427 /* This was auto-added */
3428 option->choices[i] = g_strdup ("gtk-ignore-value");
3429 option->choices_display[i] = g_strdup (_("Printer Default"));
3433 option->choices[i] = g_strdup (available[i]->choice);
3434 option->choices_display[i] = get_choice_text (ppd_file, available[i]);
3438 if (option->type != GTK_PRINTER_OPTION_TYPE_PICKONE)
3440 if (g_str_has_prefix (ppd_option->defchoice, "Custom."))
3441 gtk_printer_option_set (option, ppd_option->defchoice + 7);
3443 gtk_printer_option_set (option, ppd_option->defchoice);
3447 gtk_printer_option_set (option, ppd_option->defchoice);
3450 #ifdef PRINT_IGNORED_OPTIONS
3452 g_warning ("CUPS Backend: Ignoring pickone %s\n", ppd_option->text);
3459 static GtkPrinterOption *
3460 create_boolean_option (ppd_file_t *ppd_file,
3461 ppd_option_t *ppd_option,
3462 const gchar *gtk_name)
3464 GtkPrinterOption *option;
3465 ppd_choice_t **available;
3469 g_assert (ppd_option->ui == PPD_UI_BOOLEAN);
3473 n_choices = available_choices (ppd_file, ppd_option, &available, g_str_has_prefix (gtk_name, "gtk-"));
3476 label = get_option_text (ppd_file, ppd_option);
3477 option = gtk_printer_option_new (gtk_name, label,
3478 GTK_PRINTER_OPTION_TYPE_BOOLEAN);
3481 gtk_printer_option_allocate_choices (option, 2);
3482 option->choices[0] = g_strdup ("True");
3483 option->choices_display[0] = g_strdup ("True");
3484 option->choices[1] = g_strdup ("False");
3485 option->choices_display[1] = g_strdup ("False");
3487 gtk_printer_option_set (option, ppd_option->defchoice);
3489 #ifdef PRINT_IGNORED_OPTIONS
3491 g_warning ("CUPS Backend: Ignoring boolean %s\n", ppd_option->text);
3499 get_ppd_option_name (const gchar *keyword)
3503 for (i = 0; i < G_N_ELEMENTS (ppd_option_names); i++)
3504 if (strcmp (ppd_option_names[i].ppd_keyword, keyword) == 0)
3505 return g_strdup (ppd_option_names[i].name);
3507 return g_strdup_printf ("cups-%s", keyword);
3511 get_lpoption_name (const gchar *lpoption)
3515 for (i = 0; i < G_N_ELEMENTS (ppd_option_names); i++)
3516 if (strcmp (ppd_option_names[i].ppd_keyword, lpoption) == 0)
3517 return g_strdup (ppd_option_names[i].name);
3519 for (i = 0; i < G_N_ELEMENTS (lpoption_names); i++)
3520 if (strcmp (lpoption_names[i].lpoption, lpoption) == 0)
3521 return g_strdup (lpoption_names[i].name);
3523 return g_strdup_printf ("cups-%s", lpoption);
3527 strptr_cmp (const void *a,
3530 char **aa = (char **)a;
3531 char **bb = (char **)b;
3532 return strcmp (*aa, *bb);
3537 string_in_table (gchar *str,
3538 const gchar *table[],
3541 return bsearch (&str, table, table_len, sizeof (char *), (void *)strptr_cmp) != NULL;
3544 #define STRING_IN_TABLE(_str, _table) (string_in_table (_str, _table, G_N_ELEMENTS (_table)))
3547 handle_option (GtkPrinterOptionSet *set,
3548 ppd_file_t *ppd_file,
3549 ppd_option_t *ppd_option,
3550 ppd_group_t *toplevel_group,
3551 GtkPrintSettings *settings)
3553 GtkPrinterOption *option;
3557 if (STRING_IN_TABLE (ppd_option->keyword, cups_option_blacklist))
3560 name = get_ppd_option_name (ppd_option->keyword);
3563 if (ppd_option->ui == PPD_UI_PICKONE)
3565 option = create_pickone_option (ppd_file, ppd_option, name);
3567 else if (ppd_option->ui == PPD_UI_BOOLEAN)
3569 option = create_boolean_option (ppd_file, ppd_option, name);
3571 #ifdef PRINT_IGNORED_OPTIONS
3573 g_warning ("CUPS Backend: Ignoring pickmany setting %s\n", ppd_option->text);
3580 name = ppd_group_name (toplevel_group);
3581 if (STRING_IN_TABLE (name,
3582 color_group_whitelist) ||
3583 STRING_IN_TABLE (ppd_option->keyword,
3584 color_option_whitelist))
3586 option->group = g_strdup ("ColorPage");
3588 else if (STRING_IN_TABLE (name,
3589 image_quality_group_whitelist) ||
3590 STRING_IN_TABLE (ppd_option->keyword,
3591 image_quality_option_whitelist))
3593 option->group = g_strdup ("ImageQualityPage");
3595 else if (STRING_IN_TABLE (name,
3596 finishing_group_whitelist) ||
3597 STRING_IN_TABLE (ppd_option->keyword,
3598 finishing_option_whitelist))
3600 option->group = g_strdup ("FinishingPage");
3604 for (i = 0; i < G_N_ELEMENTS (cups_group_translations); i++)
3606 if (strcmp (cups_group_translations[i].name, toplevel_group->name) == 0)
3608 option->group = g_strdup (_(cups_group_translations[i].translation));
3613 if (i == G_N_ELEMENTS (cups_group_translations))
3614 option->group = g_strdup (toplevel_group->text);
3617 set_option_from_settings (option, settings);
3619 gtk_printer_option_set_add (set, option);
3626 handle_group (GtkPrinterOptionSet *set,
3627 ppd_file_t *ppd_file,
3629 ppd_group_t *toplevel_group,
3630 GtkPrintSettings *settings)
3635 /* Ignore installable options */
3636 name = ppd_group_name (toplevel_group);
3637 if (strcmp (name, "InstallableOptions") == 0)
3640 for (i = 0; i < group->num_options; i++)
3641 handle_option (set, ppd_file, &group->options[i], toplevel_group, settings);
3643 for (i = 0; i < group->num_subgroups; i++)
3644 handle_group (set, ppd_file, &group->subgroups[i], toplevel_group, settings);
3651 GtkPrintSettings *settings;
3652 GtkPrinter *printer;
3653 } GtkPrintBackendCupsColordHelper;
3656 colord_printer_option_set_changed_cb (GtkPrinterOptionSet *set,
3657 GtkPrintBackendCupsColordHelper *helper)
3659 gtk_printer_cups_update_settings (GTK_PRINTER_CUPS (helper->printer),
3665 static GtkPrinterOptionSet *
3666 cups_printer_get_options (GtkPrinter *printer,
3667 GtkPrintSettings *settings,
3668 GtkPageSetup *page_setup,
3669 GtkPrintCapabilities capabilities)
3671 GtkPrinterOptionSet *set;
3672 GtkPrinterOption *option;
3673 ppd_file_t *ppd_file;
3675 char *print_at[] = { "now", "at", "on-hold" };
3676 char *n_up[] = {"1", "2", "4", "6", "9", "16" };
3677 char *prio[] = {"100", "80", "50", "30" };
3678 /* Translators: These strings name the possible values of the
3679 * job priority option in the print dialog
3681 char *prio_display[] = {N_("Urgent"), N_("High"), N_("Medium"), N_("Low") };
3682 char *n_up_layout[] = { "lrtb", "lrbt", "rltb", "rlbt", "tblr", "tbrl", "btlr", "btrl" };
3683 /* Translators: These strings name the possible arrangements of
3684 * multiple pages on a sheet when printing
3686 char *n_up_layout_display[] = { N_("Left to right, top to bottom"), N_("Left to right, bottom to top"),
3687 N_("Right to left, top to bottom"), N_("Right to left, bottom to top"),
3688 N_("Top to bottom, left to right"), N_("Top to bottom, right to left"),
3689 N_("Bottom to top, left to right"), N_("Bottom to top, right to left") };
3692 cups_option_t *opts = NULL;
3693 GtkPrintBackendCups *backend;
3694 GtkTextDirection text_direction;
3695 GtkPrinterCups *cups_printer = NULL;
3697 GtkPrintBackendCupsColordHelper *helper;
3699 char *default_number_up;
3701 set = gtk_printer_option_set_new ();
3703 /* Cups specific, non-ppd related settings */
3705 for (i = 0; i < G_N_ELEMENTS(prio_display); i++)
3706 prio_display[i] = _(prio_display[i]);
3708 /* Translators, this string is used to label the job priority option
3709 * in the print dialog
3711 option = gtk_printer_option_new ("gtk-job-prio", _("Job Priority"), GTK_PRINTER_OPTION_TYPE_PICKONE);
3712 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (prio),
3713 prio, prio_display);
3714 gtk_printer_option_set (option, "50");
3715 set_option_from_settings (option, settings);
3716 gtk_printer_option_set_add (set, option);
3717 g_object_unref (option);
3719 /* Translators, this string is used to label the billing info entry
3720 * in the print dialog
3722 option = gtk_printer_option_new ("gtk-billing-info", _("Billing Info"), GTK_PRINTER_OPTION_TYPE_STRING);
3723 gtk_printer_option_set (option, "");
3724 set_option_from_settings (option, settings);
3725 gtk_printer_option_set_add (set, option);
3726 g_object_unref (option);
3728 backend = GTK_PRINT_BACKEND_CUPS (gtk_printer_get_backend (printer));
3729 cups_printer = GTK_PRINTER_CUPS (printer);
3731 if (backend != NULL && printer != NULL)
3733 char *cover_default[] = {"none", "classified", "confidential", "secret", "standard", "topsecret", "unclassified" };
3734 /* Translators, these strings are names for various 'standard' cover
3735 * pages that the printing system may support.
3737 char *cover_display_default[] = {N_("None"), N_("Classified"), N_("Confidential"), N_("Secret"), N_("Standard"), N_("Top Secret"), N_("Unclassified"),};
3738 char **cover = NULL;
3739 char **cover_display = NULL;
3740 char **cover_display_translated = NULL;
3741 gint num_of_covers = 0;
3745 /* Translators, this string is used to label the pages-per-sheet option
3746 * in the print dialog
3748 option = gtk_printer_option_new ("gtk-n-up", _("Pages per Sheet"), GTK_PRINTER_OPTION_TYPE_PICKONE);
3749 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (n_up),
3751 default_number_up = g_strdup_printf ("%d", cups_printer->default_number_up);
3752 gtk_printer_option_set (option, default_number_up);
3753 g_free (default_number_up);
3754 set_option_from_settings (option, settings);
3755 gtk_printer_option_set_add (set, option);
3756 g_object_unref (option);
3758 if (cups_printer_get_capabilities (printer) & GTK_PRINT_CAPABILITY_NUMBER_UP_LAYOUT)
3760 for (i = 0; i < G_N_ELEMENTS (n_up_layout_display); i++)
3761 n_up_layout_display[i] = _(n_up_layout_display[i]);
3763 /* Translators, this string is used to label the option in the print
3764 * dialog that controls in what order multiple pages are arranged
3766 option = gtk_printer_option_new ("gtk-n-up-layout", _("Page Ordering"), GTK_PRINTER_OPTION_TYPE_PICKONE);
3767 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (n_up_layout),
3768 n_up_layout, n_up_layout_display);
3770 text_direction = gtk_widget_get_default_direction ();
3771 if (text_direction == GTK_TEXT_DIR_LTR)
3772 gtk_printer_option_set (option, "lrtb");
3774 gtk_printer_option_set (option, "rltb");
3776 set_option_from_settings (option, settings);
3777 gtk_printer_option_set_add (set, option);
3778 g_object_unref (option);
3781 num_of_covers = backend->number_of_covers;
3782 cover = g_new (char *, num_of_covers + 1);
3783 cover[num_of_covers] = NULL;
3784 cover_display = g_new (char *, num_of_covers + 1);
3785 cover_display[num_of_covers] = NULL;
3786 cover_display_translated = g_new (char *, num_of_covers + 1);
3787 cover_display_translated[num_of_covers] = NULL;
3789 for (i = 0; i < num_of_covers; i++)
3791 cover[i] = g_strdup (backend->covers[i]);
3793 for (j = 0; j < G_N_ELEMENTS (cover_default); j++)
3794 if (strcmp (cover_default[j], cover[i]) == 0)
3796 value = cover_display_default[j];
3799 cover_display[i] = (value != NULL) ? g_strdup (value) : g_strdup (backend->covers[i]);
3802 for (i = 0; i < num_of_covers; i++)
3803 cover_display_translated[i] = _(cover_display[i]);
3805 /* Translators, this is the label used for the option in the print
3806 * dialog that controls the front cover page.
3808 option = gtk_printer_option_new ("gtk-cover-before", _("Before"), GTK_PRINTER_OPTION_TYPE_PICKONE);
3809 gtk_printer_option_choices_from_array (option, num_of_covers,
3810 cover, cover_display_translated);
3812 if (cups_printer->default_cover_before != NULL)
3813 gtk_printer_option_set (option, cups_printer->default_cover_before);
3815 gtk_printer_option_set (option, "none");
3816 set_option_from_settings (option, settings);
3817 gtk_printer_option_set_add (set, option);
3818 g_object_unref (option);
3820 /* Translators, this is the label used for the option in the print
3821 * dialog that controls the back cover page.
3823 option = gtk_printer_option_new ("gtk-cover-after", _("After"), GTK_PRINTER_OPTION_TYPE_PICKONE);
3824 gtk_printer_option_choices_from_array (option, num_of_covers,
3825 cover, cover_display_translated);
3826 if (cups_printer->default_cover_after != NULL)
3827 gtk_printer_option_set (option, cups_printer->default_cover_after);
3829 gtk_printer_option_set (option, "none");
3830 set_option_from_settings (option, settings);
3831 gtk_printer_option_set_add (set, option);
3832 g_object_unref (option);
3835 g_strfreev (cover_display);
3836 g_free (cover_display_translated);
3839 /* Translators: this is the name of the option that controls when
3840 * a print job is printed. Possible values are 'now', a specified time,
3843 option = gtk_printer_option_new ("gtk-print-time", _("Print at"), GTK_PRINTER_OPTION_TYPE_PICKONE);
3844 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (print_at),
3845 print_at, print_at);
3846 gtk_printer_option_set (option, "now");
3847 set_option_from_settings (option, settings);
3848 gtk_printer_option_set_add (set, option);
3849 g_object_unref (option);
3851 /* Translators: this is the name of the option that allows the user
3852 * to specify a time when a print job will be printed.
3854 option = gtk_printer_option_new ("gtk-print-time-text", _("Print at time"), GTK_PRINTER_OPTION_TYPE_STRING);
3855 gtk_printer_option_set (option, "");
3856 set_option_from_settings (option, settings);
3857 gtk_printer_option_set_add (set, option);
3858 g_object_unref (option);
3860 /* Printer (ppd) specific settings */
3861 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
3864 GtkPaperSize *paper_size;
3865 ppd_option_t *option;
3866 const gchar *ppd_name;
3868 ppdMarkDefaults (ppd_file);
3870 paper_size = gtk_page_setup_get_paper_size (page_setup);
3872 option = ppdFindOption (ppd_file, "PageSize");
3873 ppd_name = gtk_paper_size_get_ppd_name (paper_size);
3876 strncpy (option->defchoice, ppd_name, PPD_MAX_NAME);
3880 char width[G_ASCII_DTOSTR_BUF_SIZE];
3881 char height[G_ASCII_DTOSTR_BUF_SIZE];
3883 g_ascii_formatd (width, sizeof (width), "%.2f", gtk_paper_size_get_width (paper_size, GTK_UNIT_POINTS));
3884 g_ascii_formatd (height, sizeof (height), "%.2f", gtk_paper_size_get_height (paper_size, GTK_UNIT_POINTS));
3885 /* Translators: this format is used to display a custom paper
3886 * size. The two placeholders are replaced with the width and height
3887 * in points. E.g: "Custom 230.4x142.9"
3889 custom_name = g_strdup_printf (_("Custom %sx%s"), width, height);
3890 strncpy (option->defchoice, custom_name, PPD_MAX_NAME);
3891 g_free (custom_name);
3894 for (i = 0; i < ppd_file->num_groups; i++)
3895 handle_group (set, ppd_file, &ppd_file->groups[i], &ppd_file->groups[i], settings);
3898 /* Now honor the user set defaults for this printer */
3899 num_opts = cups_get_user_options (gtk_printer_get_name (printer), 0, &opts);
3901 for (i = 0; i < num_opts; i++)
3903 if (STRING_IN_TABLE (opts[i].name, cups_option_blacklist))
3906 name = get_lpoption_name (opts[i].name);
3907 if (strcmp (name, "cups-job-sheets") == 0)
3912 values = g_strsplit (opts[i].value, ",", 2);
3913 num_values = g_strv_length (values);
3915 option = gtk_printer_option_set_lookup (set, "gtk-cover-before");
3916 if (option && num_values > 0)
3917 gtk_printer_option_set (option, g_strstrip (values[0]));
3919 option = gtk_printer_option_set_lookup (set, "gtk-cover-after");
3920 if (option && num_values > 1)
3921 gtk_printer_option_set (option, g_strstrip (values[1]));
3923 g_strfreev (values);
3925 else if (strcmp (name, "cups-job-hold-until") == 0)
3927 GtkPrinterOption *option2 = NULL;
3929 option = gtk_printer_option_set_lookup (set, "gtk-print-time-text");
3930 if (option && opts[i].value)
3932 option2 = gtk_printer_option_set_lookup (set, "gtk-print-time");
3935 if (strcmp (opts[i].value, "indefinite") == 0)
3936 gtk_printer_option_set (option2, "on-hold");
3939 gtk_printer_option_set (option2, "at");
3940 gtk_printer_option_set (option, opts[i].value);
3945 else if (strcmp (name, "cups-sides") == 0)
3947 option = gtk_printer_option_set_lookup (set, "gtk-duplex");
3948 if (option && opts[i].value)
3950 if (strcmp (opts[i].value, "two-sided-short-edge") == 0)
3951 gtk_printer_option_set (option, "DuplexTumble");
3952 else if (strcmp (opts[i].value, "two-sided-long-edge") == 0)
3953 gtk_printer_option_set (option, "DuplexNoTumble");
3958 option = gtk_printer_option_set_lookup (set, name);
3960 gtk_printer_option_set (option, opts[i].value);
3965 cupsFreeOptions (num_opts, opts);
3968 /* TRANSLATORS: this this the ICC color profile to use for this job */
3969 option = gtk_printer_option_new ("colord-profile",
3970 _("Printer Profile"),
3971 GTK_PRINTER_OPTION_TYPE_INFO);
3973 /* assign it to the color page */
3974 option->group = g_strdup ("ColorPage");
3976 /* TRANSLATORS: this is when color profile information is unavailable */
3977 gtk_printer_option_set (option, _("Unavailable"));
3978 gtk_printer_option_set_add (set, option);
3980 /* watch to see if the user changed the options */
3981 helper = g_new (GtkPrintBackendCupsColordHelper, 1);
3982 helper->printer = printer;
3983 helper->settings = settings;
3984 g_signal_connect_data (set, "changed",
3985 G_CALLBACK (colord_printer_option_set_changed_cb),
3987 (GClosureNotify) g_free,
3990 /* initial coldplug */
3991 gtk_printer_cups_update_settings (GTK_PRINTER_CUPS (printer),
3993 g_object_bind_property (printer, "profile-title",
4004 mark_option_from_set (GtkPrinterOptionSet *set,
4005 ppd_file_t *ppd_file,
4006 ppd_option_t *ppd_option)
4008 GtkPrinterOption *option;
4009 char *name = get_ppd_option_name (ppd_option->keyword);
4011 option = gtk_printer_option_set_lookup (set, name);
4014 ppdMarkOption (ppd_file, ppd_option->keyword, option->value);
4021 mark_group_from_set (GtkPrinterOptionSet *set,
4022 ppd_file_t *ppd_file,
4027 for (i = 0; i < group->num_options; i++)
4028 mark_option_from_set (set, ppd_file, &group->options[i]);
4030 for (i = 0; i < group->num_subgroups; i++)
4031 mark_group_from_set (set, ppd_file, &group->subgroups[i]);
4035 set_conflicts_from_option (GtkPrinterOptionSet *set,
4036 ppd_file_t *ppd_file,
4037 ppd_option_t *ppd_option)
4039 GtkPrinterOption *option;
4042 if (ppd_option->conflicted)
4044 name = get_ppd_option_name (ppd_option->keyword);
4045 option = gtk_printer_option_set_lookup (set, name);
4048 gtk_printer_option_set_has_conflict (option, TRUE);
4049 #ifdef PRINT_IGNORED_OPTIONS
4051 g_warning ("CUPS Backend: Ignoring conflict for option %s", ppd_option->keyword);
4059 set_conflicts_from_group (GtkPrinterOptionSet *set,
4060 ppd_file_t *ppd_file,
4065 for (i = 0; i < group->num_options; i++)
4066 set_conflicts_from_option (set, ppd_file, &group->options[i]);
4068 for (i = 0; i < group->num_subgroups; i++)
4069 set_conflicts_from_group (set, ppd_file, &group->subgroups[i]);
4073 cups_printer_mark_conflicts (GtkPrinter *printer,
4074 GtkPrinterOptionSet *options)
4076 ppd_file_t *ppd_file;
4080 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
4082 if (ppd_file == NULL)
4085 ppdMarkDefaults (ppd_file);
4087 for (i = 0; i < ppd_file->num_groups; i++)
4088 mark_group_from_set (options, ppd_file, &ppd_file->groups[i]);
4090 num_conflicts = ppdConflicts (ppd_file);
4092 if (num_conflicts > 0)
4094 for (i = 0; i < ppd_file->num_groups; i++)
4095 set_conflicts_from_group (options, ppd_file, &ppd_file->groups[i]);
4098 return num_conflicts > 0;
4102 GtkPrinter *printer;
4103 GtkPrinterOptionSet *options;
4104 GtkPrintSettings *settings;
4105 ppd_file_t *ppd_file;
4110 const char *standard;
4114 map_settings_to_option (GtkPrinterOption *option,
4115 const NameMapping table[],
4117 GtkPrintSettings *settings,
4118 const gchar *standard_name,
4119 const gchar *cups_name)
4123 const char *cups_value;
4124 const char *standard_value;
4126 /* If the cups-specific setting is set, always use that */
4127 name = g_strdup_printf ("cups-%s", cups_name);
4128 cups_value = gtk_print_settings_get (settings, name);
4131 if (cups_value != NULL)
4133 gtk_printer_option_set (option, cups_value);
4137 /* Otherwise we try to convert from the general setting */
4138 standard_value = gtk_print_settings_get (settings, standard_name);
4139 if (standard_value == NULL)
4142 for (i = 0; i < n_elements; i++)
4144 if (table[i].cups == NULL && table[i].standard == NULL)
4146 gtk_printer_option_set (option, standard_value);
4149 else if (table[i].cups == NULL &&
4150 strcmp (table[i].standard, standard_value) == 0)
4152 set_option_off (option);
4155 else if (strcmp (table[i].standard, standard_value) == 0)
4157 gtk_printer_option_set (option, table[i].cups);
4164 map_option_to_settings (const gchar *value,
4165 const NameMapping table[],
4167 GtkPrintSettings *settings,
4168 const gchar *standard_name,
4169 const gchar *cups_name)
4174 for (i = 0; i < n_elements; i++)
4176 if (table[i].cups == NULL && table[i].standard == NULL)
4178 gtk_print_settings_set (settings,
4183 else if (table[i].cups == NULL && table[i].standard != NULL)
4185 if (value_is_off (value))
4187 gtk_print_settings_set (settings,
4193 else if (strcmp (table[i].cups, value) == 0)
4195 gtk_print_settings_set (settings,
4202 /* Always set the corresponding cups-specific setting */
4203 name = g_strdup_printf ("cups-%s", cups_name);
4204 gtk_print_settings_set (settings, name, value);
4209 static const NameMapping paper_source_map[] = {
4210 { "Lower", "lower"},
4211 { "Middle", "middle"},
4212 { "Upper", "upper"},
4214 { "Envelope", "envelope"},
4215 { "Cassette", "cassette"},
4216 { "LargeCapacity", "large-capacity"},
4217 { "AnySmallFormat", "small-format"},
4218 { "AnyLargeFormat", "large-format"},
4222 static const NameMapping output_tray_map[] = {
4223 { "Upper", "upper"},
4224 { "Lower", "lower"},
4229 static const NameMapping duplex_map[] = {
4230 { "DuplexTumble", "vertical" },
4231 { "DuplexNoTumble", "horizontal" },
4235 static const NameMapping output_mode_map[] = {
4236 { "Standard", "normal" },
4237 { "Normal", "normal" },
4238 { "Draft", "draft" },
4239 { "Fast", "draft" },
4242 static const NameMapping media_type_map[] = {
4243 { "Transparency", "transparency"},
4244 { "Standard", "stationery"},
4248 static const NameMapping all_map[] = {
4254 set_option_from_settings (GtkPrinterOption *option,
4255 GtkPrintSettings *settings)
4257 const char *cups_value;
4260 if (settings == NULL)
4263 if (strcmp (option->name, "gtk-paper-source") == 0)
4264 map_settings_to_option (option, paper_source_map, G_N_ELEMENTS (paper_source_map),
4265 settings, GTK_PRINT_SETTINGS_DEFAULT_SOURCE, "InputSlot");
4266 else if (strcmp (option->name, "gtk-output-tray") == 0)
4267 map_settings_to_option (option, output_tray_map, G_N_ELEMENTS (output_tray_map),
4268 settings, GTK_PRINT_SETTINGS_OUTPUT_BIN, "OutputBin");
4269 else if (strcmp (option->name, "gtk-duplex") == 0)
4270 map_settings_to_option (option, duplex_map, G_N_ELEMENTS (duplex_map),
4271 settings, GTK_PRINT_SETTINGS_DUPLEX, "Duplex");
4272 else if (strcmp (option->name, "cups-OutputMode") == 0)
4273 map_settings_to_option (option, output_mode_map, G_N_ELEMENTS (output_mode_map),
4274 settings, GTK_PRINT_SETTINGS_QUALITY, "OutputMode");
4275 else if (strcmp (option->name, "cups-Resolution") == 0)
4277 cups_value = gtk_print_settings_get (settings, option->name);
4279 gtk_printer_option_set (option, cups_value);
4282 if (gtk_print_settings_get_int_with_default (settings, GTK_PRINT_SETTINGS_RESOLUTION, -1) != -1 ||
4283 gtk_print_settings_get_int_with_default (settings, GTK_PRINT_SETTINGS_RESOLUTION_X, -1) != -1 ||
4284 gtk_print_settings_get_int_with_default (settings, GTK_PRINT_SETTINGS_RESOLUTION_Y, -1) != -1 ||
4285 option->value == NULL || option->value[0] == '\0')
4287 int res = gtk_print_settings_get_resolution (settings);
4288 int res_x = gtk_print_settings_get_resolution_x (settings);
4289 int res_y = gtk_print_settings_get_resolution_y (settings);
4293 value = g_strdup_printf ("%dx%ddpi", res_x, res_y);
4294 gtk_printer_option_set (option, value);
4299 value = g_strdup_printf ("%ddpi", res);
4300 gtk_printer_option_set (option, value);
4306 else if (strcmp (option->name, "gtk-paper-type") == 0)
4307 map_settings_to_option (option, media_type_map, G_N_ELEMENTS (media_type_map),
4308 settings, GTK_PRINT_SETTINGS_MEDIA_TYPE, "MediaType");
4309 else if (strcmp (option->name, "gtk-n-up") == 0)
4311 map_settings_to_option (option, all_map, G_N_ELEMENTS (all_map),
4312 settings, GTK_PRINT_SETTINGS_NUMBER_UP, "number-up");
4314 else if (strcmp (option->name, "gtk-n-up-layout") == 0)
4316 map_settings_to_option (option, all_map, G_N_ELEMENTS (all_map),
4317 settings, GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT, "number-up-layout");
4319 else if (strcmp (option->name, "gtk-billing-info") == 0)
4321 cups_value = gtk_print_settings_get (settings, "cups-job-billing");
4323 gtk_printer_option_set (option, cups_value);
4325 else if (strcmp (option->name, "gtk-job-prio") == 0)
4327 cups_value = gtk_print_settings_get (settings, "cups-job-priority");
4329 gtk_printer_option_set (option, cups_value);
4331 else if (strcmp (option->name, "gtk-cover-before") == 0)
4333 cups_value = gtk_print_settings_get (settings, "cover-before");
4335 gtk_printer_option_set (option, cups_value);
4337 else if (strcmp (option->name, "gtk-cover-after") == 0)
4339 cups_value = gtk_print_settings_get (settings, "cover-after");
4341 gtk_printer_option_set (option, cups_value);
4343 else if (strcmp (option->name, "gtk-print-time") == 0)
4345 cups_value = gtk_print_settings_get (settings, "print-at");
4347 gtk_printer_option_set (option, cups_value);
4349 else if (strcmp (option->name, "gtk-print-time-text") == 0)
4351 cups_value = gtk_print_settings_get (settings, "print-at-time");
4353 gtk_printer_option_set (option, cups_value);
4355 else if (g_str_has_prefix (option->name, "cups-"))
4357 cups_value = gtk_print_settings_get (settings, option->name);
4359 gtk_printer_option_set (option, cups_value);
4364 foreach_option_get_settings (GtkPrinterOption *option,
4367 struct OptionData *data = user_data;
4368 GtkPrintSettings *settings = data->settings;
4371 value = option->value;
4373 if (strcmp (option->name, "gtk-paper-source") == 0)
4374 map_option_to_settings (value, paper_source_map, G_N_ELEMENTS (paper_source_map),
4375 settings, GTK_PRINT_SETTINGS_DEFAULT_SOURCE, "InputSlot");
4376 else if (strcmp (option->name, "gtk-output-tray") == 0)
4377 map_option_to_settings (value, output_tray_map, G_N_ELEMENTS (output_tray_map),
4378 settings, GTK_PRINT_SETTINGS_OUTPUT_BIN, "OutputBin");
4379 else if (strcmp (option->name, "gtk-duplex") == 0)
4380 map_option_to_settings (value, duplex_map, G_N_ELEMENTS (duplex_map),
4381 settings, GTK_PRINT_SETTINGS_DUPLEX, "Duplex");
4382 else if (strcmp (option->name, "cups-OutputMode") == 0)
4383 map_option_to_settings (value, output_mode_map, G_N_ELEMENTS (output_mode_map),
4384 settings, GTK_PRINT_SETTINGS_QUALITY, "OutputMode");
4385 else if (strcmp (option->name, "cups-Resolution") == 0)
4387 int res, res_x, res_y;
4389 if (sscanf (value, "%dx%ddpi", &res_x, &res_y) == 2)
4391 if (res_x > 0 && res_y > 0)
4392 gtk_print_settings_set_resolution_xy (settings, res_x, res_y);
4394 else if (sscanf (value, "%ddpi", &res) == 1)
4397 gtk_print_settings_set_resolution (settings, res);
4400 gtk_print_settings_set (settings, option->name, value);
4402 else if (strcmp (option->name, "gtk-paper-type") == 0)
4403 map_option_to_settings (value, media_type_map, G_N_ELEMENTS (media_type_map),
4404 settings, GTK_PRINT_SETTINGS_MEDIA_TYPE, "MediaType");
4405 else if (strcmp (option->name, "gtk-n-up") == 0)
4406 map_option_to_settings (value, all_map, G_N_ELEMENTS (all_map),
4407 settings, GTK_PRINT_SETTINGS_NUMBER_UP, "number-up");
4408 else if (strcmp (option->name, "gtk-n-up-layout") == 0)
4409 map_option_to_settings (value, all_map, G_N_ELEMENTS (all_map),
4410 settings, GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT, "number-up-layout");
4411 else if (strcmp (option->name, "gtk-billing-info") == 0 && strlen (value) > 0)
4412 gtk_print_settings_set (settings, "cups-job-billing", value);
4413 else if (strcmp (option->name, "gtk-job-prio") == 0)
4414 gtk_print_settings_set (settings, "cups-job-priority", value);
4415 else if (strcmp (option->name, "gtk-cover-before") == 0)
4416 gtk_print_settings_set (settings, "cover-before", value);
4417 else if (strcmp (option->name, "gtk-cover-after") == 0)
4418 gtk_print_settings_set (settings, "cover-after", value);
4419 else if (strcmp (option->name, "gtk-print-time") == 0)
4420 gtk_print_settings_set (settings, "print-at", value);
4421 else if (strcmp (option->name, "gtk-print-time-text") == 0)
4422 gtk_print_settings_set (settings, "print-at-time", value);
4423 else if (g_str_has_prefix (option->name, "cups-"))
4424 gtk_print_settings_set (settings, option->name, value);
4428 supports_am_pm (void)
4430 struct tm tmp_tm = { 0 };
4434 length = strftime (time, sizeof (time), "%p", &tmp_tm);
4439 /* Converts local time to UTC time. Local time has to be in one of these
4440 * formats: HH:MM:SS, HH:MM, HH:MM:SS {am, pm}, HH:MM {am, pm}, HH {am, pm},
4441 * {am, pm} HH:MM:SS, {am, pm} HH:MM, {am, pm} HH.
4442 * Returns a newly allocated string holding UTC time in HH:MM:SS format
4446 localtime_to_utctime (const char *local_time)
4448 const char *formats_0[] = {" %I : %M : %S %p ", " %p %I : %M : %S ",
4450 " %I : %M %p ", " %p %I : %M ",
4452 " %I %p ", " %p %I "};
4453 const char *formats_1[] = {" %H : %M : %S ", " %H : %M "};
4454 const char *end = NULL;
4455 struct tm *actual_local_time;
4456 struct tm *actual_utc_time;
4457 struct tm local_print_time;
4458 struct tm utc_print_time;
4459 struct tm diff_time;
4460 gchar *utc_time = NULL;
4463 if (local_time == NULL || local_time[0] == '\0')
4466 n = supports_am_pm () ? G_N_ELEMENTS (formats_0) : G_N_ELEMENTS (formats_1);
4468 for (i = 0; i < n; i++)
4470 local_print_time.tm_hour = 0;
4471 local_print_time.tm_min = 0;
4472 local_print_time.tm_sec = 0;
4474 if (supports_am_pm ())
4475 end = strptime (local_time, formats_0[i], &local_print_time);
4477 end = strptime (local_time, formats_1[i], &local_print_time);
4479 if (end != NULL && end[0] == '\0')
4483 if (end != NULL && end[0] == '\0')
4488 actual_utc_time = g_memdup (gmtime (&rawtime), sizeof (struct tm));
4489 actual_local_time = g_memdup (localtime (&rawtime), sizeof (struct tm));
4491 diff_time.tm_hour = actual_utc_time->tm_hour - actual_local_time->tm_hour;
4492 diff_time.tm_min = actual_utc_time->tm_min - actual_local_time->tm_min;
4493 diff_time.tm_sec = actual_utc_time->tm_sec - actual_local_time->tm_sec;
4495 utc_print_time.tm_hour = ((local_print_time.tm_hour + diff_time.tm_hour) + 24) % 24;
4496 utc_print_time.tm_min = ((local_print_time.tm_min + diff_time.tm_min) + 60) % 60;
4497 utc_print_time.tm_sec = ((local_print_time.tm_sec + diff_time.tm_sec) + 60) % 60;
4499 utc_time = g_strdup_printf ("%02d:%02d:%02d",
4500 utc_print_time.tm_hour,
4501 utc_print_time.tm_min,
4502 utc_print_time.tm_sec);
4509 cups_printer_get_settings_from_options (GtkPrinter *printer,
4510 GtkPrinterOptionSet *options,
4511 GtkPrintSettings *settings)
4513 struct OptionData data;
4514 const char *print_at, *print_at_time;
4516 data.printer = printer;
4517 data.options = options;
4518 data.settings = settings;
4519 data.ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
4521 if (data.ppd_file != NULL)
4523 GtkPrinterOption *cover_before, *cover_after;
4525 gtk_printer_option_set_foreach (options, foreach_option_get_settings, &data);
4527 cover_before = gtk_printer_option_set_lookup (options, "gtk-cover-before");
4528 cover_after = gtk_printer_option_set_lookup (options, "gtk-cover-after");
4529 if (cover_before && cover_after)
4531 char *value = g_strdup_printf ("%s,%s", cover_before->value, cover_after->value);
4532 gtk_print_settings_set (settings, "cups-job-sheets", value);
4536 print_at = gtk_print_settings_get (settings, "print-at");
4537 print_at_time = gtk_print_settings_get (settings, "print-at-time");
4539 if (strcmp (print_at, "at") == 0)
4541 gchar *utc_time = NULL;
4543 utc_time = localtime_to_utctime (print_at_time);
4545 if (utc_time != NULL)
4547 gtk_print_settings_set (settings, "cups-job-hold-until", utc_time);
4551 gtk_print_settings_set (settings, "cups-job-hold-until", print_at_time);
4553 else if (strcmp (print_at, "on-hold") == 0)
4554 gtk_print_settings_set (settings, "cups-job-hold-until", "indefinite");
4559 cups_printer_prepare_for_print (GtkPrinter *printer,
4560 GtkPrintJob *print_job,
4561 GtkPrintSettings *settings,
4562 GtkPageSetup *page_setup)
4564 GtkPrintPages pages;
4565 GtkPageRange *ranges;
4567 GtkPageSet page_set;
4568 GtkPaperSize *paper_size;
4569 const char *ppd_paper_name;
4572 pages = gtk_print_settings_get_print_pages (settings);
4573 gtk_print_job_set_pages (print_job, pages);
4575 if (pages == GTK_PRINT_PAGES_RANGES)
4576 ranges = gtk_print_settings_get_page_ranges (settings, &n_ranges);
4583 gtk_print_job_set_page_ranges (print_job, ranges, n_ranges);
4584 if (gtk_print_settings_get_collate (settings))
4585 gtk_print_settings_set (settings, "cups-Collate", "True");
4586 gtk_print_job_set_collate (print_job, FALSE);
4588 if (gtk_print_settings_get_reverse (settings))
4589 gtk_print_settings_set (settings, "cups-OutputOrder", "Reverse");
4590 gtk_print_job_set_reverse (print_job, FALSE);
4592 if (gtk_print_settings_get_n_copies (settings) > 1)
4593 gtk_print_settings_set_int (settings, "cups-copies",
4594 gtk_print_settings_get_n_copies (settings));
4595 gtk_print_job_set_num_copies (print_job, 1);
4597 scale = gtk_print_settings_get_scale (settings);
4599 gtk_print_job_set_scale (print_job, scale / 100.0);
4601 page_set = gtk_print_settings_get_page_set (settings);
4602 if (page_set == GTK_PAGE_SET_EVEN)
4603 gtk_print_settings_set (settings, "cups-page-set", "even");
4604 else if (page_set == GTK_PAGE_SET_ODD)
4605 gtk_print_settings_set (settings, "cups-page-set", "odd");
4606 gtk_print_job_set_page_set (print_job, GTK_PAGE_SET_ALL);
4608 paper_size = gtk_page_setup_get_paper_size (page_setup);
4609 ppd_paper_name = gtk_paper_size_get_ppd_name (paper_size);
4610 if (ppd_paper_name != NULL)
4611 gtk_print_settings_set (settings, "cups-PageSize", ppd_paper_name);
4614 char width[G_ASCII_DTOSTR_BUF_SIZE];
4615 char height[G_ASCII_DTOSTR_BUF_SIZE];
4618 g_ascii_formatd (width, sizeof (width), "%.2f", gtk_paper_size_get_width (paper_size, GTK_UNIT_POINTS));
4619 g_ascii_formatd (height, sizeof (height), "%.2f", gtk_paper_size_get_height (paper_size, GTK_UNIT_POINTS));
4620 custom_name = g_strdup_printf (("Custom.%sx%s"), width, height);
4621 gtk_print_settings_set (settings, "cups-PageSize", custom_name);
4622 g_free (custom_name);
4625 if (gtk_print_settings_get_number_up (settings) > 1)
4627 GtkNumberUpLayout layout = gtk_print_settings_get_number_up_layout (settings);
4628 GEnumClass *enum_class;
4629 GEnumValue *enum_value;
4631 switch (gtk_page_setup_get_orientation (page_setup))
4633 case GTK_PAGE_ORIENTATION_PORTRAIT:
4635 case GTK_PAGE_ORIENTATION_LANDSCAPE:
4637 layout = layout + 2 + 4 * (1 - layout / 2);
4639 layout = layout - 3 - 2 * (layout % 2);
4641 case GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT:
4642 layout = (layout + 3 - 2 * (layout % 2)) % 4 + 4 * (layout / 4);
4644 case GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE:
4646 layout = layout + 5 - 2 * (layout % 2);
4648 layout = layout - 6 + 4 * (1 - (layout - 4) / 2);
4652 enum_class = g_type_class_ref (GTK_TYPE_NUMBER_UP_LAYOUT);
4653 enum_value = g_enum_get_value (enum_class, layout);
4654 gtk_print_settings_set (settings, "cups-number-up-layout", enum_value->value_nick);
4655 g_type_class_unref (enum_class);
4658 gtk_print_job_set_rotate (print_job, TRUE);
4661 static GtkPageSetup *
4662 create_page_setup (ppd_file_t *ppd_file,
4666 GtkPageSetup *page_setup;
4667 GtkPaperSize *paper_size;
4668 ppd_option_t *option;
4669 ppd_choice_t *choice;
4671 display_name = NULL;
4672 option = ppdFindOption (ppd_file, "PageSize");
4675 choice = ppdFindChoice (option, size->name);
4677 display_name = ppd_text_to_utf8 (ppd_file, choice->text);
4680 if (display_name == NULL)
4681 display_name = g_strdup (size->name);
4683 page_setup = gtk_page_setup_new ();
4684 paper_size = gtk_paper_size_new_from_ppd (size->name,
4688 gtk_page_setup_set_paper_size (page_setup, paper_size);
4689 gtk_paper_size_free (paper_size);
4691 gtk_page_setup_set_top_margin (page_setup, size->length - size->top, GTK_UNIT_POINTS);
4692 gtk_page_setup_set_bottom_margin (page_setup, size->bottom, GTK_UNIT_POINTS);
4693 gtk_page_setup_set_left_margin (page_setup, size->left, GTK_UNIT_POINTS);
4694 gtk_page_setup_set_right_margin (page_setup, size->width - size->right, GTK_UNIT_POINTS);
4696 g_free (display_name);
4702 cups_printer_list_papers (GtkPrinter *printer)
4704 ppd_file_t *ppd_file;
4706 GtkPageSetup *page_setup;
4710 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
4711 if (ppd_file == NULL)
4716 for (i = 0; i < ppd_file->num_sizes; i++)
4718 size = &ppd_file->sizes[i];
4720 page_setup = create_page_setup (ppd_file, size);
4722 l = g_list_prepend (l, page_setup);
4725 return g_list_reverse (l);
4728 static GtkPageSetup *
4729 cups_printer_get_default_page_size (GtkPrinter *printer)
4731 ppd_file_t *ppd_file;
4733 ppd_option_t *option;
4736 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
4737 if (ppd_file == NULL)
4740 option = ppdFindOption (ppd_file, "PageSize");
4744 size = ppdPageSize (ppd_file, option->defchoice);
4748 return create_page_setup (ppd_file, size);
4752 cups_printer_get_hard_margins (GtkPrinter *printer,
4758 ppd_file_t *ppd_file;
4760 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
4761 if (ppd_file == NULL)
4764 *left = ppd_file->custom_margins[0];
4765 *bottom = ppd_file->custom_margins[1];
4766 *right = ppd_file->custom_margins[2];
4767 *top = ppd_file->custom_margins[3];
4772 static GtkPrintCapabilities
4773 cups_printer_get_capabilities (GtkPrinter *printer)
4776 GTK_PRINT_CAPABILITY_COPIES |
4777 GTK_PRINT_CAPABILITY_COLLATE |
4778 GTK_PRINT_CAPABILITY_REVERSE |
4779 GTK_PRINT_CAPABILITY_NUMBER_UP_LAYOUT |
4780 GTK_PRINT_CAPABILITY_NUMBER_UP;