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, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
29 #include <sys/types.h>
34 #include <cups/cups.h>
35 #include <cups/language.h>
36 #include <cups/http.h>
40 #include <cairo-pdf.h>
43 #include <glib/gstdio.h>
44 #include <glib/gi18n-lib.h>
48 #include <gtk/gtkprintbackend.h>
49 #include <gtk/gtkunixprint.h>
50 #include <gtk/gtkprinter-private.h>
52 #include "gtkprintbackendcups.h"
53 #include "gtkprintercups.h"
55 #include "gtkcupsutils.h"
58 typedef struct _GtkPrintBackendCupsClass GtkPrintBackendCupsClass;
60 #define GTK_PRINT_BACKEND_CUPS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_BACKEND_CUPS, GtkPrintBackendCupsClass))
61 #define GTK_IS_PRINT_BACKEND_CUPS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_BACKEND_CUPS))
62 #define GTK_PRINT_BACKEND_CUPS_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_BACKEND_CUPS, GtkPrintBackendCupsClass))
64 #define _CUPS_MAX_ATTEMPTS 10
65 #define _CUPS_MAX_CHUNK_SIZE 8192
67 /* define this to see warnings about ignored ppd options */
68 #undef PRINT_IGNORED_OPTIONS
70 #define _CUPS_MAP_ATTR_INT(attr, v, a) {if (!g_ascii_strcasecmp (attr->name, (a))) v = attr->values[0].integer;}
71 #define _CUPS_MAP_ATTR_STR(attr, v, a) {if (!g_ascii_strcasecmp (attr->name, (a))) v = attr->values[0].string.text;}
73 static GType print_backend_cups_type = 0;
75 typedef void (* GtkPrintCupsResponseCallbackFunc) (GtkPrintBackend *print_backend,
76 GtkCupsResult *result,
87 } GtkPrintCupsDispatchState;
94 GtkCupsRequest *request;
96 GtkPrintBackendCups *backend;
98 } GtkPrintCupsDispatchWatch;
100 struct _GtkPrintBackendCupsClass
102 GtkPrintBackendClass parent_class;
105 struct _GtkPrintBackendCups
107 GtkPrintBackend parent_instance;
109 char *default_printer;
111 guint list_printers_poll;
112 guint list_printers_pending : 1;
113 guint got_default_printer : 1;
114 guint default_printer_poll;
115 GtkCupsConnectionTest *cups_connection_test;
118 char *default_cover_before;
119 char *default_cover_after;
120 int number_of_covers;
125 gboolean authentication_lock;
128 static GObjectClass *backend_parent_class;
130 static void gtk_print_backend_cups_class_init (GtkPrintBackendCupsClass *class);
131 static void gtk_print_backend_cups_init (GtkPrintBackendCups *impl);
132 static void gtk_print_backend_cups_finalize (GObject *object);
133 static void gtk_print_backend_cups_dispose (GObject *object);
134 static void cups_get_printer_list (GtkPrintBackend *print_backend);
135 static void cups_get_default_printer (GtkPrintBackendCups *print_backend);
136 static void cups_get_local_default_printer (GtkPrintBackendCups *print_backend);
137 static void cups_request_execute (GtkPrintBackendCups *print_backend,
138 GtkCupsRequest *request,
139 GtkPrintCupsResponseCallbackFunc callback,
141 GDestroyNotify notify);
142 static void cups_printer_get_settings_from_options (GtkPrinter *printer,
143 GtkPrinterOptionSet *options,
144 GtkPrintSettings *settings);
145 static gboolean cups_printer_mark_conflicts (GtkPrinter *printer,
146 GtkPrinterOptionSet *options);
147 static GtkPrinterOptionSet *cups_printer_get_options (GtkPrinter *printer,
148 GtkPrintSettings *settings,
149 GtkPageSetup *page_setup,
150 GtkPrintCapabilities capabilities);
151 static void cups_printer_prepare_for_print (GtkPrinter *printer,
152 GtkPrintJob *print_job,
153 GtkPrintSettings *settings,
154 GtkPageSetup *page_setup);
155 static GList * cups_printer_list_papers (GtkPrinter *printer);
156 static GtkPageSetup * cups_printer_get_default_page_size (GtkPrinter *printer);
157 static void cups_printer_request_details (GtkPrinter *printer);
158 static gboolean cups_request_default_printer (GtkPrintBackendCups *print_backend);
159 static void cups_request_ppd (GtkPrinter *printer);
160 static void cups_printer_get_hard_margins (GtkPrinter *printer,
165 static GtkPrintCapabilities cups_printer_get_capabilities (GtkPrinter *printer);
166 static void set_option_from_settings (GtkPrinterOption *option,
167 GtkPrintSettings *setting);
168 static void cups_begin_polling_info (GtkPrintBackendCups *print_backend,
171 static gboolean cups_job_info_poll_timeout (gpointer user_data);
172 static void gtk_print_backend_cups_print_stream (GtkPrintBackend *backend,
175 GtkPrintJobCompleteFunc callback,
177 GDestroyNotify dnotify);
178 static cairo_surface_t * cups_printer_create_cairo_surface (GtkPrinter *printer,
179 GtkPrintSettings *settings,
182 GIOChannel *cache_io);
184 static void gtk_print_backend_cups_set_password (GtkPrintBackend *backend,
185 const gchar *hostname,
186 const gchar *username,
187 const gchar *password);
189 void overwrite_and_free (gpointer data);
190 static gboolean is_address_local (const gchar *address);
193 gtk_print_backend_cups_register_type (GTypeModule *module)
195 static const GTypeInfo print_backend_cups_info =
197 sizeof (GtkPrintBackendCupsClass),
198 NULL, /* base_init */
199 NULL, /* base_finalize */
200 (GClassInitFunc) gtk_print_backend_cups_class_init,
201 NULL, /* class_finalize */
202 NULL, /* class_data */
203 sizeof (GtkPrintBackendCups),
205 (GInstanceInitFunc) gtk_print_backend_cups_init
208 print_backend_cups_type = g_type_module_register_type (module,
209 GTK_TYPE_PRINT_BACKEND,
210 "GtkPrintBackendCups",
211 &print_backend_cups_info, 0);
215 pb_module_init (GTypeModule *module)
218 g_print ("CUPS Backend: Initializing the CUPS print backend module\n"));
220 gtk_print_backend_cups_register_type (module);
221 gtk_printer_cups_register_type (module);
225 pb_module_exit (void)
230 G_MODULE_EXPORT GtkPrintBackend *
231 pb_module_create (void)
233 return gtk_print_backend_cups_new ();
237 * GtkPrintBackendCups
240 gtk_print_backend_cups_get_type (void)
242 return print_backend_cups_type;
246 * gtk_print_backend_cups_new:
248 * Creates a new #GtkPrintBackendCups object. #GtkPrintBackendCups
249 * implements the #GtkPrintBackend interface with direct access to
250 * the filesystem using Unix/Linux API calls
252 * Return value: the new #GtkPrintBackendCups object
255 gtk_print_backend_cups_new (void)
258 g_print ("CUPS Backend: Creating a new CUPS print backend object\n"));
260 return g_object_new (GTK_TYPE_PRINT_BACKEND_CUPS, NULL);
264 gtk_print_backend_cups_class_init (GtkPrintBackendCupsClass *class)
266 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
267 GtkPrintBackendClass *backend_class = GTK_PRINT_BACKEND_CLASS (class);
269 backend_parent_class = g_type_class_peek_parent (class);
271 gobject_class->finalize = gtk_print_backend_cups_finalize;
272 gobject_class->dispose = gtk_print_backend_cups_dispose;
274 backend_class->request_printer_list = cups_get_printer_list;
275 backend_class->print_stream = gtk_print_backend_cups_print_stream;
276 backend_class->printer_request_details = cups_printer_request_details;
277 backend_class->printer_create_cairo_surface = cups_printer_create_cairo_surface;
278 backend_class->printer_get_options = cups_printer_get_options;
279 backend_class->printer_mark_conflicts = cups_printer_mark_conflicts;
280 backend_class->printer_get_settings_from_options = cups_printer_get_settings_from_options;
281 backend_class->printer_prepare_for_print = cups_printer_prepare_for_print;
282 backend_class->printer_list_papers = cups_printer_list_papers;
283 backend_class->printer_get_default_page_size = cups_printer_get_default_page_size;
284 backend_class->printer_get_hard_margins = cups_printer_get_hard_margins;
285 backend_class->printer_get_capabilities = cups_printer_get_capabilities;
286 backend_class->set_password = gtk_print_backend_cups_set_password;
289 static cairo_status_t
290 _cairo_write_to_cups (void *closure,
291 const unsigned char *data,
294 GIOChannel *io = (GIOChannel *)closure;
301 g_print ("CUPS Backend: Writing %i byte chunk to temp file\n", length));
305 g_io_channel_write_chars (io, (gchar *)data, length, &written, &error);
310 g_print ("CUPS Backend: Error writing to temp file, %s\n",
313 g_error_free (error);
314 return CAIRO_STATUS_WRITE_ERROR;
318 g_print ("CUPS Backend: Wrote %i bytes to temp file\n", written));
324 return CAIRO_STATUS_SUCCESS;
327 static cairo_surface_t *
328 cups_printer_create_cairo_surface (GtkPrinter *printer,
329 GtkPrintSettings *settings,
332 GIOChannel *cache_io)
334 cairo_surface_t *surface;
335 ppd_file_t *ppd_file = NULL;
336 ppd_attr_t *ppd_attr = NULL;
337 ppd_attr_t *ppd_attr_res = NULL;
338 ppd_attr_t *ppd_attr_screen_freq = NULL;
339 ppd_attr_t *ppd_attr_res_screen_freq = NULL;
340 gchar *res_string = NULL;
343 /* TODO: check if it is a ps or pdf printer */
345 surface = cairo_ps_surface_create_for_stream (_cairo_write_to_cups, cache_io, width, height);
347 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
349 if (ppd_file != NULL)
351 ppd_attr = ppdFindAttr (ppd_file, "LanguageLevel", NULL);
353 if (ppd_attr != NULL)
354 level = atoi (ppd_attr->value);
356 if (gtk_print_settings_get_resolution (settings) == 0)
358 ppd_attr_res = ppdFindAttr (ppd_file, "DefaultResolution", NULL);
360 if (ppd_attr_res != NULL)
362 int res, res_x, res_y;
364 if (sscanf (ppd_attr_res->value, "%dx%ddpi", &res_x, &res_y) == 2)
366 if (res_x != 0 && res_y != 0)
367 gtk_print_settings_set_resolution_xy (settings, res_x, res_y);
369 else if (sscanf (ppd_attr_res->value, "%ddpi", &res) == 1)
372 gtk_print_settings_set_resolution (settings, res);
375 gtk_print_settings_set_resolution (settings, 300);
379 res_string = g_strdup_printf ("%ddpi",
380 gtk_print_settings_get_resolution (settings));
381 ppd_attr_res_screen_freq = ppdFindAttr (ppd_file, "ResScreenFreq", res_string);
384 if (ppd_attr_res_screen_freq == NULL)
386 res_string = g_strdup_printf ("%dx%ddpi",
387 gtk_print_settings_get_resolution_x (settings),
388 gtk_print_settings_get_resolution_y (settings));
389 ppd_attr_res_screen_freq = ppdFindAttr (ppd_file, "ResScreenFreq", res_string);
393 ppd_attr_screen_freq = ppdFindAttr (ppd_file, "ScreenFreq", NULL);
395 if (ppd_attr_res_screen_freq != NULL)
396 gtk_print_settings_set_printer_lpi (settings, atof (ppd_attr_res_screen_freq->value));
397 else if (ppd_attr_screen_freq != NULL)
398 gtk_print_settings_set_printer_lpi (settings, atof (ppd_attr_screen_freq->value));
400 gtk_print_settings_set_printer_lpi (settings, 150.0);
404 gtk_print_settings_set_resolution (settings, 300);
405 gtk_print_settings_set_printer_lpi (settings, 150.0);
409 cairo_ps_surface_restrict_to_level (surface, CAIRO_PS_LEVEL_2);
412 cairo_ps_surface_restrict_to_level (surface, CAIRO_PS_LEVEL_3);
414 cairo_surface_set_fallback_resolution (surface,
415 2.0 * gtk_print_settings_get_printer_lpi (settings),
416 2.0 * gtk_print_settings_get_printer_lpi (settings));
422 GtkPrintJobCompleteFunc callback;
425 GDestroyNotify dnotify;
426 } CupsPrintStreamData;
429 cups_free_print_stream_data (CupsPrintStreamData *data)
432 g_print ("CUPS Backend: %s\n", G_STRFUNC));
435 data->dnotify (data->user_data);
436 g_object_unref (data->job);
441 cups_print_cb (GtkPrintBackendCups *print_backend,
442 GtkCupsResult *result,
445 GError *error = NULL;
446 CupsPrintStreamData *ps = user_data;
448 GDK_THREADS_ENTER ();
451 g_print ("CUPS Backend: %s\n", G_STRFUNC));
453 if (gtk_cups_result_is_error (result))
454 error = g_error_new_literal (gtk_print_error_quark (),
455 GTK_PRINT_ERROR_INTERNAL_ERROR,
456 gtk_cups_result_get_error_string (result));
459 ps->callback (ps->job, ps->user_data, error);
464 ipp_attribute_t *attr; /* IPP job-id attribute */
465 ipp_t *response = gtk_cups_result_get_response (result);
467 if ((attr = ippFindAttribute (response, "job-id", IPP_TAG_INTEGER)) != NULL)
468 job_id = attr->values[0].integer;
470 if (!gtk_print_job_get_track_print_status (ps->job) || job_id == 0)
471 gtk_print_job_set_status (ps->job, GTK_PRINT_STATUS_FINISHED);
474 gtk_print_job_set_status (ps->job, GTK_PRINT_STATUS_PENDING);
475 cups_begin_polling_info (print_backend, ps->job, job_id);
479 gtk_print_job_set_status (ps->job, GTK_PRINT_STATUS_FINISHED_ABORTED);
483 g_error_free (error);
485 GDK_THREADS_LEAVE ();
489 add_cups_options (const gchar *key,
493 GtkCupsRequest *request = user_data;
495 if (!g_str_has_prefix (key, "cups-"))
498 if (strcmp (value, "gtk-ignore-value") == 0)
501 key = key + strlen ("cups-");
503 gtk_cups_request_encode_option (request, key, value);
507 gtk_print_backend_cups_print_stream (GtkPrintBackend *print_backend,
510 GtkPrintJobCompleteFunc callback,
512 GDestroyNotify dnotify)
514 GtkPrinterCups *cups_printer;
515 CupsPrintStreamData *ps;
516 GtkCupsRequest *request;
517 GtkPrintSettings *settings;
519 char printer_absolute_uri[HTTP_MAX_URI];
522 g_print ("CUPS Backend: %s\n", G_STRFUNC));
524 cups_printer = GTK_PRINTER_CUPS (gtk_print_job_get_printer (job));
525 settings = gtk_print_job_get_settings (job);
527 request = gtk_cups_request_new_with_username (NULL,
532 cups_printer->device_uri,
533 GTK_PRINT_BACKEND_CUPS (print_backend)->username);
535 #if (CUPS_VERSION_MAJOR == 1 && CUPS_VERSION_MINOR >= 2) || CUPS_VERSION_MAJOR > 1
536 httpAssembleURIf (HTTP_URI_CODING_ALL,
537 printer_absolute_uri,
538 sizeof (printer_absolute_uri),
544 gtk_printer_get_name (gtk_print_job_get_printer (job)));
546 g_snprintf (printer_absolute_uri,
547 sizeof (printer_absolute_uri),
548 "ipp://localhost:%d/printers/%s",
550 gtk_printer_get_name (gtk_print_job_get_printer (job)));
553 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION,
554 IPP_TAG_URI, "printer-uri",
555 NULL, printer_absolute_uri);
557 title = gtk_print_job_get_title (job);
559 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION,
560 IPP_TAG_NAME, "job-name",
563 gtk_print_settings_foreach (settings, add_cups_options, request);
565 ps = g_new0 (CupsPrintStreamData, 1);
566 ps->callback = callback;
567 ps->user_data = user_data;
568 ps->dnotify = dnotify;
569 ps->job = g_object_ref (job);
571 cups_request_execute (GTK_PRINT_BACKEND_CUPS (print_backend),
573 (GtkPrintCupsResponseCallbackFunc) cups_print_cb,
575 (GDestroyNotify)cups_free_print_stream_data);
578 void overwrite_and_free (gpointer data)
580 gchar *password = (gchar *) data;
582 if (password != NULL)
584 memset (password, 0, strlen (password));
590 gtk_print_backend_cups_init (GtkPrintBackendCups *backend_cups)
592 backend_cups->list_printers_poll = FALSE;
593 backend_cups->got_default_printer = FALSE;
594 backend_cups->list_printers_pending = FALSE;
596 backend_cups->requests = NULL;
597 backend_cups->auth = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, overwrite_and_free);
598 backend_cups->authentication_lock = FALSE;
600 backend_cups->covers = NULL;
601 backend_cups->default_cover_before = NULL;
602 backend_cups->default_cover_after = NULL;
603 backend_cups->number_of_covers = 0;
605 backend_cups->default_printer_poll = 0;
606 backend_cups->cups_connection_test = NULL;
608 backend_cups->username = NULL;
610 cups_get_local_default_printer (backend_cups);
614 gtk_print_backend_cups_finalize (GObject *object)
616 GtkPrintBackendCups *backend_cups;
619 g_print ("CUPS Backend: finalizing CUPS backend module\n"));
621 backend_cups = GTK_PRINT_BACKEND_CUPS (object);
623 g_free (backend_cups->default_printer);
624 backend_cups->default_printer = NULL;
626 g_strfreev (backend_cups->covers);
627 backend_cups->number_of_covers = 0;
629 g_free (backend_cups->default_cover_before);
630 g_free (backend_cups->default_cover_after);
632 gtk_cups_connection_test_free (backend_cups->cups_connection_test);
633 backend_cups->cups_connection_test = NULL;
635 g_hash_table_destroy (backend_cups->auth);
637 g_free (backend_cups->username);
639 backend_parent_class->finalize (object);
643 gtk_print_backend_cups_dispose (GObject *object)
645 GtkPrintBackendCups *backend_cups;
648 g_print ("CUPS Backend: %s\n", G_STRFUNC));
650 backend_cups = GTK_PRINT_BACKEND_CUPS (object);
652 if (backend_cups->list_printers_poll > 0)
653 g_source_remove (backend_cups->list_printers_poll);
654 backend_cups->list_printers_poll = 0;
656 if (backend_cups->default_printer_poll > 0)
657 g_source_remove (backend_cups->default_printer_poll);
658 backend_cups->default_printer_poll = 0;
660 backend_parent_class->dispose (object);
664 is_address_local (const gchar *address)
666 if (address[0] == '/' ||
667 strcmp (address, "127.0.0.1") == 0 ||
668 strcmp (address, "[::1]") == 0)
675 gtk_print_backend_cups_set_password (GtkPrintBackend *backend,
676 const gchar *hostname,
677 const gchar *username,
678 const gchar *password)
680 GtkPrintBackendCups *cups_backend = GTK_PRINT_BACKEND_CUPS (backend);
682 char dispatch_hostname[HTTP_MAX_URI];
685 key = g_strconcat (username, "@", hostname, NULL);
686 g_hash_table_insert (cups_backend->auth, key, g_strdup (password));
688 g_free (cups_backend->username);
689 cups_backend->username = g_strdup (username);
692 g_print ("CUPS backend: storing password for %s\n", key));
694 for (l = cups_backend->requests; l; l = l->next)
696 GtkPrintCupsDispatchWatch *dispatch = l->data;
698 httpGetHostname (dispatch->request->http, dispatch_hostname, sizeof (dispatch_hostname));
699 if (is_address_local (dispatch_hostname))
700 strcpy (dispatch_hostname, "localhost");
702 if (strcmp (hostname, dispatch_hostname) == 0)
704 overwrite_and_free (dispatch->request->password);
705 dispatch->request->password = g_strdup (password);
706 g_free (dispatch->request->username);
707 dispatch->request->username = g_strdup (username);
708 dispatch->request->password_state = GTK_CUPS_PASSWORD_HAS;
709 dispatch->backend->authentication_lock = FALSE;
715 request_password (gpointer data)
717 GtkPrintCupsDispatchWatch *dispatch = data;
718 const gchar *username;
720 gchar *prompt = NULL;
722 char hostname[HTTP_MAX_URI];
724 if (dispatch->backend->authentication_lock)
727 httpGetHostname (dispatch->request->http, hostname, sizeof (hostname));
728 if (is_address_local (hostname))
729 strcpy (hostname, "localhost");
731 if (dispatch->backend->username != NULL)
732 username = dispatch->backend->username;
734 username = cupsUser ();
736 key = g_strconcat (username, "@", hostname, NULL);
737 password = g_hash_table_lookup (dispatch->backend->auth, key);
739 if (password && dispatch->request->password_state != GTK_CUPS_PASSWORD_NOT_VALID)
742 g_print ("CUPS backend: using stored password for %s\n", key));
744 overwrite_and_free (dispatch->request->password);
745 dispatch->request->password = g_strdup (password);
746 g_free (dispatch->request->username);
747 dispatch->request->username = g_strdup (username);
748 dispatch->request->password_state = GTK_CUPS_PASSWORD_HAS;
752 const char *job_title = gtk_cups_request_ipp_get_string (dispatch->request, IPP_TAG_NAME, "job-name");
753 const char *printer_uri = gtk_cups_request_ipp_get_string (dispatch->request, IPP_TAG_URI, "printer-uri");
754 char *printer_name = NULL;
756 if (printer_uri != NULL && strrchr (printer_uri, '/') != NULL)
757 printer_name = g_strdup (strrchr (printer_uri, '/') + 1);
759 if (dispatch->request->password_state == GTK_CUPS_PASSWORD_NOT_VALID)
760 g_hash_table_remove (dispatch->backend->auth, key);
762 dispatch->request->password_state = GTK_CUPS_PASSWORD_REQUESTED;
764 dispatch->backend->authentication_lock = TRUE;
766 switch (dispatch->request->ipp_request->request.op.operation_id)
769 prompt = g_strdup_printf ( _("Authentication is required to get a file from %s"), hostname);
772 if (job_title != NULL && printer_name != NULL)
773 prompt = g_strdup_printf ( _("Authentication is required to print document '%s' on printer %s"), job_title, printer_name);
775 prompt = g_strdup_printf ( _("Authentication is required to print a document on %s"), hostname);
777 case IPP_GET_JOB_ATTRIBUTES:
778 if (job_title != NULL)
779 prompt = g_strdup_printf ( _("Authentication is required to get attributes of job '%s'"), job_title);
781 prompt = g_strdup ( _("Authentication is required to get attributes of a job"));
783 case IPP_GET_PRINTER_ATTRIBUTES:
784 if (printer_name != NULL)
785 prompt = g_strdup_printf ( _("Authentication is required to get attributes of printer %s"), printer_name);
787 prompt = g_strdup ( _("Authentication is required to get attributes of a printer"));
789 case CUPS_GET_DEFAULT:
790 prompt = g_strdup_printf ( _("Authentication is required to get default printer of %s"), hostname);
792 case CUPS_GET_PRINTERS:
793 prompt = g_strdup_printf ( _("Authentication is required to get printers from %s"), hostname);
796 prompt = g_strdup_printf ( _("Authentication is required on %s"), hostname);
800 g_free (printer_name);
802 g_signal_emit_by_name (dispatch->backend, "request-password",
803 hostname, username, prompt);
814 cups_dispatch_watch_check (GSource *source)
816 GtkPrintCupsDispatchWatch *dispatch;
817 GtkCupsPollState poll_state;
821 g_print ("CUPS Backend: %s <source %p>\n", G_STRFUNC, source));
823 dispatch = (GtkPrintCupsDispatchWatch *) source;
825 poll_state = gtk_cups_request_get_poll_state (dispatch->request);
827 if (dispatch->request->http != NULL)
829 if (dispatch->data_poll == NULL)
831 dispatch->data_poll = g_new0 (GPollFD, 1);
832 g_source_add_poll (source, dispatch->data_poll);
836 if (poll_state == GTK_CUPS_HTTP_READ)
837 dispatch->data_poll->events = G_IO_IN | G_IO_HUP | G_IO_ERR | G_IO_PRI;
838 else if (poll_state == GTK_CUPS_HTTP_WRITE)
839 dispatch->data_poll->events = G_IO_OUT | G_IO_ERR;
841 dispatch->data_poll->events = 0;
844 #ifdef HAVE_CUPS_API_1_2
845 dispatch->data_poll->fd = httpGetFd (dispatch->request->http);
847 dispatch->data_poll->fd = dispatch->request->http->fd;
851 if (poll_state != GTK_CUPS_HTTP_IDLE && !dispatch->request->need_password)
852 if (!(dispatch->data_poll->revents & dispatch->data_poll->events))
855 result = gtk_cups_request_read_write (dispatch->request);
856 if (result && dispatch->data_poll != NULL)
858 g_source_remove_poll (source, dispatch->data_poll);
859 g_free (dispatch->data_poll);
860 dispatch->data_poll = NULL;
863 if (dispatch->request->need_password && dispatch->request->password_state != GTK_CUPS_PASSWORD_REQUESTED)
865 dispatch->request->need_password = FALSE;
866 g_idle_add (request_password, dispatch);
874 cups_dispatch_watch_prepare (GSource *source,
877 GtkPrintCupsDispatchWatch *dispatch;
879 dispatch = (GtkPrintCupsDispatchWatch *) source;
882 g_print ("CUPS Backend: %s <source %p>\n", G_STRFUNC, source));
886 return gtk_cups_request_read_write (dispatch->request);
890 cups_dispatch_watch_dispatch (GSource *source,
891 GSourceFunc callback,
894 GtkPrintCupsDispatchWatch *dispatch;
895 GtkPrintCupsResponseCallbackFunc ep_callback;
896 GtkCupsResult *result;
898 g_assert (callback != NULL);
900 ep_callback = (GtkPrintCupsResponseCallbackFunc) callback;
902 dispatch = (GtkPrintCupsDispatchWatch *) source;
904 result = gtk_cups_request_get_result (dispatch->request);
907 g_print ("CUPS Backend: %s <source %p>\n", G_STRFUNC, source));
909 if (gtk_cups_result_is_error (result))
912 g_print("Error result: %s (type %i, status %i, code %i)\n",
913 gtk_cups_result_get_error_string (result),
914 gtk_cups_result_get_error_type (result),
915 gtk_cups_result_get_error_status (result),
916 gtk_cups_result_get_error_code (result)));
919 ep_callback (GTK_PRINT_BACKEND (dispatch->backend), result, user_data);
925 cups_dispatch_watch_finalize (GSource *source)
927 GtkPrintCupsDispatchWatch *dispatch;
928 GtkCupsResult *result;
931 g_print ("CUPS Backend: %s <source %p>\n", G_STRFUNC, source));
933 dispatch = (GtkPrintCupsDispatchWatch *) source;
935 result = gtk_cups_request_get_result (dispatch->request);
936 if (gtk_cups_result_get_error_type (result) == GTK_CUPS_ERROR_AUTH)
938 const gchar *username;
939 gchar hostname[HTTP_MAX_URI];
942 httpGetHostname (dispatch->request->http, hostname, sizeof (hostname));
943 if (is_address_local (hostname))
944 strcpy (hostname, "localhost");
946 if (dispatch->backend->username != NULL)
947 username = dispatch->backend->username;
949 username = cupsUser ();
951 key = g_strconcat (username, "@", hostname, NULL);
953 g_print ("CUPS backend: removing stored password for %s\n", key));
954 g_hash_table_remove (dispatch->backend->auth, key);
957 if (dispatch->backend)
958 dispatch->backend->authentication_lock = FALSE;
961 gtk_cups_request_free (dispatch->request);
963 if (dispatch->backend)
965 /* We need to unref this at idle time, because it might be the
966 * last reference to this module causing the code to be
967 * unloaded (including this particular function!)
968 * Update: Doing this at idle caused a deadlock taking the
969 * mainloop context lock while being in a GSource callout for
970 * multithreaded apps. So, for now we just disable unloading
971 * of print backends. See _gtk_print_backend_create for the
975 dispatch->backend->requests = g_list_remove (dispatch->backend->requests, dispatch);
978 g_object_unref (dispatch->backend);
979 dispatch->backend = NULL;
982 g_free (dispatch->data_poll);
985 static GSourceFuncs _cups_dispatch_watch_funcs = {
986 cups_dispatch_watch_prepare,
987 cups_dispatch_watch_check,
988 cups_dispatch_watch_dispatch,
989 cups_dispatch_watch_finalize
994 cups_request_execute (GtkPrintBackendCups *print_backend,
995 GtkCupsRequest *request,
996 GtkPrintCupsResponseCallbackFunc callback,
998 GDestroyNotify notify)
1000 GtkPrintCupsDispatchWatch *dispatch;
1002 dispatch = (GtkPrintCupsDispatchWatch *) g_source_new (&_cups_dispatch_watch_funcs,
1003 sizeof (GtkPrintCupsDispatchWatch));
1006 g_print ("CUPS Backend: %s <source %p> - Executing cups request on server '%s' and resource '%s'\n", G_STRFUNC, dispatch, request->server, request->resource));
1008 dispatch->request = request;
1009 dispatch->backend = g_object_ref (print_backend);
1010 dispatch->data_poll = NULL;
1012 print_backend->requests = g_list_prepend (print_backend->requests, dispatch);
1014 g_source_set_callback ((GSource *) dispatch, (GSourceFunc) callback, user_data, notify);
1016 g_source_attach ((GSource *) dispatch, NULL);
1017 g_source_unref ((GSource *) dispatch);
1022 cups_request_printer_info_cb (GtkPrintBackendCups *backend,
1023 GtkCupsResult *result,
1026 ipp_attribute_t *attr;
1028 gchar *printer_name;
1029 GtkPrinterCups *cups_printer;
1030 GtkPrinter *printer;
1035 gboolean status_changed;
1037 g_assert (GTK_IS_PRINT_BACKEND_CUPS (backend));
1039 printer_name = (gchar *)user_data;
1040 printer = gtk_print_backend_find_printer (GTK_PRINT_BACKEND (backend),
1044 g_print ("CUPS Backend: %s - Got printer info for printer '%s'\n", G_STRFUNC, printer_name));
1049 g_print ("CUPS Backend: Could not find printer called '%s'\n", printer_name));
1053 cups_printer = GTK_PRINTER_CUPS (printer);
1055 if (gtk_cups_result_is_error (result))
1057 if (gtk_printer_is_new (printer))
1059 gtk_print_backend_remove_printer (GTK_PRINT_BACKEND (backend),
1064 return; /* TODO: mark as inactive printer */
1067 response = gtk_cups_result_get_response (result);
1069 /* TODO: determine printer type and use correct icon */
1070 gtk_printer_set_icon_name (printer, "gtk-print");
1076 for (attr = response->attrs; attr != NULL; attr = attr->next)
1081 _CUPS_MAP_ATTR_STR (attr, loc, "printer-location");
1082 _CUPS_MAP_ATTR_STR (attr, desc, "printer-info");
1083 _CUPS_MAP_ATTR_STR (attr, state_msg, "printer-state-message");
1084 _CUPS_MAP_ATTR_INT (attr, cups_printer->state, "printer-state");
1085 _CUPS_MAP_ATTR_INT (attr, job_count, "queued-job-count");
1088 status_changed = gtk_printer_set_job_count (printer, job_count);
1090 status_changed |= gtk_printer_set_location (printer, loc);
1091 status_changed |= gtk_printer_set_description (printer, desc);
1092 status_changed |= gtk_printer_set_state_message (printer, state_msg);
1095 g_signal_emit_by_name (GTK_PRINT_BACKEND (backend),
1096 "printer-status-changed", printer);
1100 cups_request_printer_info (GtkPrintBackendCups *print_backend,
1101 const gchar *printer_name)
1103 GtkCupsRequest *request;
1105 static const char * const pattrs[] = /* Attributes we're interested in */
1109 "printer-state-message",
1112 "job-sheets-supported",
1113 "job-sheets-default"
1116 request = gtk_cups_request_new_with_username (NULL,
1118 IPP_GET_PRINTER_ATTRIBUTES,
1122 print_backend->username);
1124 printer_uri = g_strdup_printf ("ipp://localhost/printers/%s",
1126 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION, IPP_TAG_URI,
1127 "printer-uri", NULL, printer_uri);
1130 g_print ("CUPS Backend: %s - Requesting printer info for URI '%s'\n", G_STRFUNC, printer_uri));
1132 g_free (printer_uri);
1134 gtk_cups_request_ipp_add_strings (request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
1135 "requested-attributes", G_N_ELEMENTS (pattrs),
1138 cups_request_execute (print_backend,
1140 (GtkPrintCupsResponseCallbackFunc) cups_request_printer_info_cb,
1141 g_strdup (printer_name),
1142 (GDestroyNotify) g_free);
1147 GtkPrintBackendCups *print_backend;
1154 job_object_died (gpointer user_data,
1155 GObject *where_the_object_was)
1157 CupsJobPollData *data = user_data;
1162 cups_job_poll_data_free (CupsJobPollData *data)
1165 g_object_weak_unref (G_OBJECT (data->job), job_object_died, data);
1171 cups_request_job_info_cb (GtkPrintBackendCups *print_backend,
1172 GtkCupsResult *result,
1175 CupsJobPollData *data = user_data;
1176 ipp_attribute_t *attr;
1181 GDK_THREADS_ENTER ();
1183 if (data->job == NULL)
1185 cups_job_poll_data_free (data);
1191 response = gtk_cups_result_get_response (result);
1194 for (attr = response->attrs; attr != NULL; attr = attr->next)
1199 _CUPS_MAP_ATTR_INT (attr, state, "job-state");
1205 case IPP_JOB_PENDING:
1207 case IPP_JOB_STOPPED:
1208 gtk_print_job_set_status (data->job,
1209 GTK_PRINT_STATUS_PENDING);
1211 case IPP_JOB_PROCESSING:
1212 gtk_print_job_set_status (data->job,
1213 GTK_PRINT_STATUS_PRINTING);
1216 case IPP_JOB_CANCELLED:
1217 case IPP_JOB_ABORTED:
1218 gtk_print_job_set_status (data->job,
1219 GTK_PRINT_STATUS_FINISHED_ABORTED);
1223 case IPP_JOB_COMPLETED:
1224 gtk_print_job_set_status (data->job,
1225 GTK_PRINT_STATUS_FINISHED);
1230 if (!done && data->job != NULL)
1234 if (data->counter < 5)
1236 else if (data->counter < 10)
1241 g_timeout_add (timeout, cups_job_info_poll_timeout, data);
1244 cups_job_poll_data_free (data);
1247 GDK_THREADS_LEAVE ();
1251 cups_request_job_info (CupsJobPollData *data)
1253 GtkCupsRequest *request;
1256 request = gtk_cups_request_new_with_username (NULL,
1258 IPP_GET_JOB_ATTRIBUTES,
1262 data->print_backend->username);
1264 job_uri = g_strdup_printf ("ipp://localhost/jobs/%d", data->job_id);
1265 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION, IPP_TAG_URI,
1266 "job-uri", NULL, job_uri);
1269 cups_request_execute (data->print_backend,
1271 (GtkPrintCupsResponseCallbackFunc) cups_request_job_info_cb,
1277 cups_job_info_poll_timeout (gpointer user_data)
1279 CupsJobPollData *data = user_data;
1281 if (data->job == NULL)
1282 cups_job_poll_data_free (data);
1284 cups_request_job_info (data);
1290 cups_begin_polling_info (GtkPrintBackendCups *print_backend,
1294 CupsJobPollData *data;
1296 data = g_new0 (CupsJobPollData, 1);
1298 data->print_backend = print_backend;
1300 data->job_id = job_id;
1303 g_object_weak_ref (G_OBJECT (job), job_object_died, data);
1305 cups_request_job_info (data);
1309 mark_printer_inactive (GtkPrinter *printer,
1310 GtkPrintBackend *backend)
1312 gtk_printer_set_is_active (printer, FALSE);
1313 g_signal_emit_by_name (backend, "printer-removed", printer);
1317 find_printer (GtkPrinter *printer,
1318 const gchar *find_name)
1320 const gchar *printer_name;
1322 printer_name = gtk_printer_get_name (printer);
1323 return g_ascii_strcasecmp (printer_name, find_name);
1327 cups_request_printer_list_cb (GtkPrintBackendCups *cups_backend,
1328 GtkCupsResult *result,
1331 GtkPrintBackend *backend = GTK_PRINT_BACKEND (cups_backend);
1332 ipp_attribute_t *attr;
1334 gboolean list_has_changed;
1335 GList *removed_printer_checklist;
1337 GDK_THREADS_ENTER ();
1339 list_has_changed = FALSE;
1342 g_print ("CUPS Backend: %s\n", G_STRFUNC));
1344 cups_backend->list_printers_pending = FALSE;
1346 if (gtk_cups_result_is_error (result))
1349 g_warning ("CUPS Backend: Error getting printer list: %s %d %d",
1350 gtk_cups_result_get_error_string (result),
1351 gtk_cups_result_get_error_type (result),
1352 gtk_cups_result_get_error_code (result)));
1354 if (gtk_cups_result_get_error_type (result) == GTK_CUPS_ERROR_AUTH &&
1355 gtk_cups_result_get_error_code (result) == 1)
1357 /* Canceled by user, stop popping up more password dialogs */
1358 if (cups_backend->list_printers_poll > 0)
1359 g_source_remove (cups_backend->list_printers_poll);
1360 cups_backend->list_printers_poll = 0;
1366 /* Gather the names of the printers in the current queue
1367 * so we may check to see if they were removed
1369 removed_printer_checklist = gtk_print_backend_get_printer_list (backend);
1371 response = gtk_cups_result_get_response (result);
1373 for (attr = response->attrs; attr != NULL; attr = attr->next)
1375 GtkPrinter *printer;
1376 const gchar *printer_name = NULL;
1377 const gchar *printer_uri = NULL;
1378 const gchar *member_uris = NULL;
1379 const gchar *location = NULL;
1380 const gchar *description = NULL;
1381 const gchar *state_msg = NULL;
1384 gboolean status_changed = FALSE;
1387 const gchar *reason_msg = NULL;
1388 gchar *reason_msg_desc = NULL;
1389 gchar *tmp_msg = NULL;
1390 gchar *tmp_msg2 = NULL;
1391 gint printer_state_reason_level = 0; /* 0 - none, 1 - report, 2 - warning, 3 - error */
1392 gboolean interested_in = FALSE;
1393 gboolean found = FALSE;
1394 static const char * const reasons[] = /* Reasons we're interested in */
1400 "marker-supply-low",
1401 "marker-supply-empty",
1407 "connecting-to-device",
1410 static const char * reasons_descs[] =
1412 N_("Printer '%s' is low on toner."),
1413 N_("Printer '%s' has no toner left."),
1414 /* Translators: "Developer" like on photo development context */
1415 N_("Printer '%s' is low on developer."),
1416 /* Translators: "Developer" like on photo development context */
1417 N_("Printer '%s' is out of developer."),
1418 /* Translators: "marker" is one color bin of the printer */
1419 N_("Printer '%s' is low on at least one marker supply."),
1420 /* Translators: "marker" is one color bin of the printer */
1421 N_("Printer '%s' is out of at least one marker supply."),
1422 N_("The cover is open on printer '%s'."),
1423 N_("The door is open on printer '%s'."),
1424 N_("Printer '%s' is low on paper."),
1425 N_("Printer '%s' is out of paper."),
1426 N_("Printer '%s' is currently off-line."),
1427 N_("Printer '%s' may not be connected."),
1428 N_("There is a problem on printer '%s'.")
1430 gboolean is_paused = FALSE;
1431 gboolean is_accepting_jobs = TRUE;
1432 gboolean default_printer = FALSE;
1433 gboolean got_printer_type = FALSE;
1435 /* Skip leading attributes until we hit a printer...
1437 while (attr != NULL && attr->group_tag != IPP_TAG_PRINTER)
1443 while (attr != NULL && attr->group_tag == IPP_TAG_PRINTER)
1445 if (strcmp (attr->name, "printer-name") == 0 &&
1446 attr->value_tag == IPP_TAG_NAME)
1447 printer_name = attr->values[0].string.text;
1448 else if (strcmp (attr->name, "printer-uri-supported") == 0 &&
1449 attr->value_tag == IPP_TAG_URI)
1450 printer_uri = attr->values[0].string.text;
1451 else if (strcmp (attr->name, "member-uris") == 0 &&
1452 attr->value_tag == IPP_TAG_URI)
1453 member_uris = attr->values[0].string.text;
1454 else if (strcmp (attr->name, "printer-location") == 0)
1455 location = attr->values[0].string.text;
1456 else if (strcmp (attr->name, "printer-info") == 0)
1457 description = attr->values[0].string.text;
1458 else if (strcmp (attr->name, "printer-state-message") == 0)
1459 state_msg = attr->values[0].string.text;
1460 else if (strcmp (attr->name, "printer-state-reasons") == 0)
1461 /* Store most important reason to reason_msg and set
1462 its importance at printer_state_reason_level */
1464 for (i = 0; i < attr->num_values; i++)
1466 if (strcmp (attr->values[i].string.text, "none") != 0)
1468 /* Sets is_paused flag for paused printer. */
1469 if (strcmp (attr->values[i].string.text, "paused") == 0)
1474 interested_in = FALSE;
1475 for (j = 0; j < G_N_ELEMENTS (reasons); j++)
1476 if (strncmp (attr->values[i].string.text, reasons[j], strlen (reasons[j])) == 0)
1478 interested_in = TRUE;
1484 if (g_str_has_suffix (attr->values[i].string.text, "-report"))
1486 if (printer_state_reason_level <= 1)
1488 reason_msg = attr->values[i].string.text;
1489 printer_state_reason_level = 1;
1492 else if (g_str_has_suffix (attr->values[i].string.text, "-warning"))
1494 if (printer_state_reason_level <= 2)
1496 reason_msg = attr->values[i].string.text;
1497 printer_state_reason_level = 2;
1500 else /* It is error in the case of no suffix. */
1502 reason_msg = attr->values[i].string.text;
1503 printer_state_reason_level = 3;
1509 else if (strcmp (attr->name, "printer-state") == 0)
1510 state = attr->values[0].integer;
1511 else if (strcmp (attr->name, "queued-job-count") == 0)
1512 job_count = attr->values[0].integer;
1513 else if (strcmp (attr->name, "printer-is-accepting-jobs") == 0)
1515 if (attr->values[0].boolean == 1)
1516 is_accepting_jobs = TRUE;
1518 is_accepting_jobs = FALSE;
1520 else if (strcmp (attr->name, "job-sheets-supported") == 0)
1522 if (cups_backend->covers == NULL)
1524 cups_backend->number_of_covers = attr->num_values;
1525 cups_backend->covers = g_new (char *, cups_backend->number_of_covers + 1);
1527 for (i = 0; i < cups_backend->number_of_covers; i++)
1528 cups_backend->covers[i] = g_strdup (attr->values[i].string.text);
1530 cups_backend->covers[cups_backend->number_of_covers] = NULL;
1533 else if (strcmp (attr->name, "job-sheets-default") == 0)
1535 if ( (cups_backend->default_cover_before == NULL) && (cups_backend->default_cover_after == NULL))
1537 if (attr->num_values == 2)
1539 cups_backend->default_cover_before = g_strdup (attr->values[0].string.text);
1540 cups_backend->default_cover_after = g_strdup (attr->values[1].string.text);
1544 else if (strcmp (attr->name, "printer-type") == 0)
1546 got_printer_type = TRUE;
1547 if (attr->values[0].integer & 0x00020000)
1548 default_printer = TRUE;
1550 default_printer = FALSE;
1555 g_print ("CUPS Backend: Attribute %s ignored", attr->name));
1561 if (printer_name == NULL ||
1562 (printer_uri == NULL && member_uris == NULL))
1570 if (got_printer_type)
1572 if (default_printer && !cups_backend->got_default_printer)
1574 cups_backend->got_default_printer = TRUE;
1575 cups_backend->default_printer = g_strdup (printer_name);
1580 if (!cups_backend->got_default_printer)
1581 cups_get_default_printer (cups_backend);
1584 /* remove name from checklist if it was found */
1585 node = g_list_find_custom (removed_printer_checklist, printer_name, (GCompareFunc) find_printer);
1586 removed_printer_checklist = g_list_delete_link (removed_printer_checklist, node);
1588 printer = gtk_print_backend_find_printer (backend, printer_name);
1591 GtkPrinterCups *cups_printer;
1592 char uri[HTTP_MAX_URI]; /* Printer URI */
1593 char method[HTTP_MAX_URI]; /* Method/scheme name */
1594 char username[HTTP_MAX_URI]; /* Username:password */
1595 char hostname[HTTP_MAX_URI]; /* Hostname */
1596 char resource[HTTP_MAX_URI]; /* Resource name */
1597 int port; /* Port number */
1598 char *cups_server; /* CUPS server */
1600 list_has_changed = TRUE;
1601 cups_printer = gtk_printer_cups_new (printer_name, backend);
1603 cups_printer->device_uri = g_strdup_printf ("/printers/%s", printer_name);
1605 /* Check to see if we are looking at a class */
1608 cups_printer->printer_uri = g_strdup (member_uris);
1609 /* TODO if member_uris is a class we need to recursivly find a printer */
1611 g_print ("CUPS Backend: Found class with printer %s\n", member_uris));
1615 cups_printer->printer_uri = g_strdup (printer_uri);
1617 g_print ("CUPS Backend: Found printer %s\n", printer_uri));
1620 #if (CUPS_VERSION_MAJOR == 1 && CUPS_VERSION_MINOR >= 2) || CUPS_VERSION_MAJOR > 1
1621 httpSeparateURI (HTTP_URI_CODING_ALL, cups_printer->printer_uri,
1622 method, sizeof (method),
1623 username, sizeof (username),
1624 hostname, sizeof (hostname),
1626 resource, sizeof (resource));
1629 httpSeparate (cups_printer->printer_uri,
1637 if (strncmp (resource, "/printers/", 10) == 0)
1639 cups_printer->ppd_name = g_strdup (resource + 10);
1641 g_print ("CUPS Backend: Setting ppd name '%s' for printer/class '%s'\n", cups_printer->ppd_name, printer_name));
1644 gethostname (uri, sizeof (uri));
1645 cups_server = g_strdup (cupsServer());
1647 if (strcasecmp (uri, hostname) == 0)
1648 strcpy (hostname, "localhost");
1650 /* if the cups server is local and listening at a unix domain socket
1651 * then use the socket connection
1653 if ((strstr (hostname, "localhost") != NULL) &&
1654 (cups_server[0] == '/'))
1655 strcpy (hostname, cups_server);
1657 g_free (cups_server);
1659 cups_printer->hostname = g_strdup (hostname);
1660 cups_printer->port = port;
1662 printer = GTK_PRINTER (cups_printer);
1664 if (cups_backend->default_printer != NULL &&
1665 strcmp (cups_backend->default_printer, gtk_printer_get_name (printer)) == 0)
1666 gtk_printer_set_is_default (printer, TRUE);
1669 gtk_print_backend_add_printer (backend, printer);
1672 g_object_ref (printer);
1674 gtk_printer_set_is_paused (printer, is_paused);
1675 gtk_printer_set_is_accepting_jobs (printer, is_accepting_jobs);
1677 if (!gtk_printer_is_active (printer))
1679 gtk_printer_set_is_active (printer, TRUE);
1680 gtk_printer_set_is_new (printer, TRUE);
1681 list_has_changed = TRUE;
1684 if (gtk_printer_is_new (printer))
1686 g_signal_emit_by_name (backend, "printer-added", printer);
1688 gtk_printer_set_is_new (printer, FALSE);
1692 /* Getting printer info with separate requests overwhelms cups
1693 * when the printer list has more than a handful of printers.
1695 cups_request_printer_info (cups_backend, gtk_printer_get_name (printer));
1698 GTK_PRINTER_CUPS (printer)->state = state;
1699 status_changed = gtk_printer_set_job_count (printer, job_count);
1700 status_changed |= gtk_printer_set_location (printer, location);
1701 status_changed |= gtk_printer_set_description (printer, description);
1703 if (state_msg != NULL && strlen (state_msg) == 0)
1705 if (is_paused && !is_accepting_jobs)
1706 /* Translators: this is a printer status. */
1707 tmp_msg2 = g_strdup ( N_("Paused ; Rejecting Jobs"));
1708 if (is_paused && is_accepting_jobs)
1709 /* Translators: this is a printer status. */
1710 tmp_msg2 = g_strdup ( N_("Paused"));
1711 if (!is_paused && !is_accepting_jobs)
1712 /* Translators: this is a printer status. */
1713 tmp_msg2 = g_strdup ( N_("Rejecting Jobs"));
1715 if (tmp_msg2 != NULL)
1716 state_msg = tmp_msg2;
1719 /* Set description of the reason and combine it with printer-state-message. */
1720 if ( (reason_msg != NULL))
1722 for (i = 0; i < G_N_ELEMENTS (reasons); i++)
1724 if (strncmp (reason_msg, reasons[i], strlen (reasons[i])) == 0)
1726 reason_msg_desc = g_strdup_printf (reasons_descs[i], printer_name);
1733 printer_state_reason_level = 0;
1735 if (printer_state_reason_level >= 2)
1737 if (strlen (state_msg) == 0)
1738 state_msg = reason_msg_desc;
1741 tmp_msg = g_strjoin (" ; ", state_msg, reason_msg_desc, NULL);
1742 state_msg = tmp_msg;
1747 status_changed |= gtk_printer_set_state_message (printer, state_msg);
1748 status_changed |= gtk_printer_set_is_accepting_jobs (printer, is_accepting_jobs);
1750 if (tmp_msg != NULL)
1753 if (tmp_msg2 != NULL)
1756 if (reason_msg_desc != NULL)
1757 g_free (reason_msg_desc);
1759 /* Set printer icon according to importance
1760 (none, report, warning, error - report is omitted). */
1761 if (printer_state_reason_level == 3)
1762 gtk_printer_set_icon_name (printer, "gtk-print-error");
1763 else if (printer_state_reason_level == 2)
1764 gtk_printer_set_icon_name (printer, "gtk-print-warning");
1765 else if (gtk_printer_is_paused (printer))
1766 gtk_printer_set_icon_name (printer, "gtk-print-paused");
1768 gtk_printer_set_icon_name (printer, "gtk-print");
1771 g_signal_emit_by_name (GTK_PRINT_BACKEND (backend),
1772 "printer-status-changed", printer);
1774 /* The ref is held by GtkPrintBackend, in add_printer() */
1775 g_object_unref (printer);
1781 /* look at the removed printers checklist and mark any printer
1782 as inactive if it is in the list, emitting a printer_removed signal */
1783 if (removed_printer_checklist != NULL)
1785 g_list_foreach (removed_printer_checklist, (GFunc) mark_printer_inactive, backend);
1786 g_list_free (removed_printer_checklist);
1787 list_has_changed = TRUE;
1791 if (list_has_changed)
1792 g_signal_emit_by_name (backend, "printer-list-changed");
1794 gtk_print_backend_set_list_done (backend);
1796 GDK_THREADS_LEAVE ();
1800 update_backend_status (GtkPrintBackendCups *cups_backend,
1801 GtkCupsConnectionState state)
1805 case GTK_CUPS_CONNECTION_NOT_AVAILABLE:
1806 g_object_set (cups_backend, "status", GTK_PRINT_BACKEND_STATUS_UNAVAILABLE, NULL);
1808 case GTK_CUPS_CONNECTION_AVAILABLE:
1809 g_object_set (cups_backend, "status", GTK_PRINT_BACKEND_STATUS_OK, NULL);
1816 cups_request_printer_list (GtkPrintBackendCups *cups_backend)
1818 GtkCupsConnectionState state;
1819 GtkCupsRequest *request;
1820 static const char * const pattrs[] = /* Attributes we're interested in */
1823 "printer-uri-supported",
1827 "printer-state-message",
1828 "printer-state-reasons",
1831 "printer-is-accepting-jobs",
1832 "job-sheets-supported",
1833 "job-sheets-default",
1837 if (cups_backend->list_printers_pending)
1840 state = gtk_cups_connection_test_get_state (cups_backend->cups_connection_test);
1841 update_backend_status (cups_backend, state);
1843 if (state == GTK_CUPS_CONNECTION_IN_PROGRESS || state == GTK_CUPS_CONNECTION_NOT_AVAILABLE)
1846 cups_backend->list_printers_pending = TRUE;
1848 request = gtk_cups_request_new_with_username (NULL,
1854 cups_backend->username);
1856 gtk_cups_request_ipp_add_strings (request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
1857 "requested-attributes", G_N_ELEMENTS (pattrs),
1860 cups_request_execute (cups_backend,
1862 (GtkPrintCupsResponseCallbackFunc) cups_request_printer_list_cb,
1870 cups_get_printer_list (GtkPrintBackend *backend)
1872 GtkPrintBackendCups *cups_backend;
1874 cups_backend = GTK_PRINT_BACKEND_CUPS (backend);
1876 if (cups_backend->cups_connection_test == NULL)
1877 cups_backend->cups_connection_test = gtk_cups_connection_test_new (NULL);
1879 if (cups_backend->list_printers_poll == 0)
1881 if (cups_request_printer_list (cups_backend))
1882 cups_backend->list_printers_poll = gdk_threads_add_timeout_seconds (3,
1883 (GSourceFunc) cups_request_printer_list,
1889 GtkPrinterCups *printer;
1895 get_ppd_data_free (GetPPDData *data)
1898 g_print ("CUPS Backend: %s\n", G_STRFUNC));
1899 httpClose (data->http);
1900 g_io_channel_unref (data->ppd_io);
1901 g_object_unref (data->printer);
1906 cups_request_ppd_cb (GtkPrintBackendCups *print_backend,
1907 GtkCupsResult *result,
1911 GtkPrinter *printer;
1913 GDK_THREADS_ENTER ();
1916 g_print ("CUPS Backend: %s\n", G_STRFUNC));
1918 printer = GTK_PRINTER (data->printer);
1919 GTK_PRINTER_CUPS (printer)->reading_ppd = FALSE;
1921 if (gtk_cups_result_is_error (result))
1923 gboolean success = FALSE;
1925 /* if we get a 404 then it is just a raw printer without a ppd
1927 if ((gtk_cups_result_get_error_type (result) == GTK_CUPS_ERROR_HTTP) &&
1928 (gtk_cups_result_get_error_status (result) == HTTP_NOT_FOUND))
1930 gtk_printer_set_has_details (printer, TRUE);
1934 g_signal_emit_by_name (printer, "details-acquired", success);
1938 response = gtk_cups_result_get_response (result);
1940 /* let ppdOpenFd take over the ownership of the open file */
1941 g_io_channel_seek_position (data->ppd_io, 0, G_SEEK_SET, NULL);
1942 data->printer->ppd_file = ppdOpenFd (dup (g_io_channel_unix_get_fd (data->ppd_io)));
1944 ppdMarkDefaults (data->printer->ppd_file);
1946 gtk_printer_set_has_details (printer, TRUE);
1947 g_signal_emit_by_name (printer, "details-acquired", TRUE);
1950 GDK_THREADS_LEAVE ();
1954 cups_request_ppd (GtkPrinter *printer)
1957 GtkPrintBackend *print_backend;
1958 GtkPrinterCups *cups_printer;
1959 GtkCupsRequest *request;
1966 cups_printer = GTK_PRINTER_CUPS (printer);
1971 g_print ("CUPS Backend: %s\n", G_STRFUNC));
1973 http = httpConnectEncrypt (cups_printer->hostname,
1977 data = g_new0 (GetPPDData, 1);
1979 fd = g_file_open_tmp ("gtkprint_ppd_XXXXXX",
1983 #ifdef G_ENABLE_DEBUG
1984 /* If we are debugging printing don't delete the tmp files */
1985 if (!(gtk_debug_flags & GTK_DEBUG_PRINTING))
1986 unlink (ppd_filename);
1988 unlink (ppd_filename);
1989 #endif /* G_ENABLE_DEBUG */
1994 g_warning ("CUPS Backend: Failed to create temp file, %s\n",
1996 g_error_free (error);
1998 g_free (ppd_filename);
2001 g_signal_emit_by_name (printer, "details-acquired", FALSE);
2006 fchmod (fd, S_IRUSR | S_IWUSR);
2007 data->ppd_io = g_io_channel_unix_new (fd);
2008 g_io_channel_set_encoding (data->ppd_io, NULL, NULL);
2009 g_io_channel_set_close_on_unref (data->ppd_io, TRUE);
2011 data->printer = g_object_ref (printer);
2013 resource = g_strdup_printf ("/printers/%s.ppd",
2014 gtk_printer_cups_get_ppd_name (GTK_PRINTER_CUPS (printer)));
2016 print_backend = gtk_printer_get_backend (printer);
2018 request = gtk_cups_request_new_with_username (data->http,
2022 cups_printer->hostname,
2024 GTK_PRINT_BACKEND_CUPS (print_backend)->username);
2027 g_print ("CUPS Backend: Requesting resource %s to be written to temp file %s\n", resource, ppd_filename));
2030 cups_printer->reading_ppd = TRUE;
2032 cups_request_execute (GTK_PRINT_BACKEND_CUPS (print_backend),
2034 (GtkPrintCupsResponseCallbackFunc) cups_request_ppd_cb,
2036 (GDestroyNotify)get_ppd_data_free);
2039 g_free (ppd_filename);
2042 /* Ordering matters for default preference */
2043 static const char *lpoptions_locations[] = {
2044 "/etc/cups/lpoptions",
2050 cups_parse_user_default_printer (const char *filename,
2051 char **printer_name)
2054 char line[1024], *lineptr, *defname = NULL;
2056 if ((fp = g_fopen (filename, "r")) == NULL)
2059 while (fgets (line, sizeof (line), fp) != NULL)
2061 if (strncasecmp (line, "default", 7) != 0 || !isspace (line[7]))
2065 while (isspace (*lineptr))
2072 while (!isspace (*lineptr) && *lineptr && *lineptr != '/')
2077 if (*printer_name != NULL)
2078 g_free (*printer_name);
2080 *printer_name = g_strdup (defname);
2087 cups_get_user_default_printer (char **printer_name)
2091 for (i = 0; i < G_N_ELEMENTS (lpoptions_locations); i++)
2093 if (g_path_is_absolute (lpoptions_locations[i]))
2095 cups_parse_user_default_printer (lpoptions_locations[i],
2102 filename = g_build_filename (g_get_home_dir (),
2103 lpoptions_locations[i], NULL);
2104 cups_parse_user_default_printer (filename, printer_name);
2111 cups_parse_user_options (const char *filename,
2112 const char *printer_name,
2114 cups_option_t **options)
2117 gchar line[1024], *lineptr, *name;
2119 if ((fp = g_fopen (filename, "r")) == NULL)
2122 while (fgets (line, sizeof (line), fp) != NULL)
2124 if (strncasecmp (line, "dest", 4) == 0 && isspace (line[4]))
2126 else if (strncasecmp (line, "default", 7) == 0 && isspace (line[7]))
2131 /* Skip leading whitespace */
2132 while (isspace (*lineptr))
2138 /* NUL-terminate the name, stripping the instance name */
2140 while (!isspace (*lineptr) && *lineptr)
2142 if (*lineptr == '/')
2152 if (strncasecmp (name, printer_name, strlen (printer_name)) != 0)
2155 /* We found our printer, parse the options */
2156 num_options = cupsParseOptions (lineptr, num_options, options);
2165 cups_get_user_options (const char *printer_name,
2167 cups_option_t **options)
2171 for (i = 0; i < G_N_ELEMENTS (lpoptions_locations); i++)
2173 if (g_path_is_absolute (lpoptions_locations[i]))
2175 num_options = cups_parse_user_options (lpoptions_locations[i],
2184 filename = g_build_filename (g_get_home_dir (),
2185 lpoptions_locations[i], NULL);
2186 num_options = cups_parse_user_options (filename, printer_name,
2187 num_options, options);
2195 /* This function requests default printer from a CUPS server in regular intervals.
2196 * In the case of unreachable CUPS server the request is repeated later.
2197 * The default printer is not requested in the case of previous success.
2200 cups_get_default_printer (GtkPrintBackendCups *backend)
2202 GtkPrintBackendCups *cups_backend;
2204 cups_backend = backend;
2206 if (cups_backend->cups_connection_test == NULL)
2207 cups_backend->cups_connection_test = gtk_cups_connection_test_new (NULL);
2209 if (cups_backend->default_printer_poll == 0)
2211 if (cups_request_default_printer (cups_backend))
2212 cups_backend->default_printer_poll = gdk_threads_add_timeout (500,
2213 (GSourceFunc) cups_request_default_printer,
2218 /* This function gets default printer from local settings.*/
2220 cups_get_local_default_printer (GtkPrintBackendCups *backend)
2225 if ((str = g_getenv ("LPDEST")) != NULL)
2227 backend->default_printer = g_strdup (str);
2228 backend->got_default_printer = TRUE;
2231 else if ((str = g_getenv ("PRINTER")) != NULL &&
2232 strcmp (str, "lp") != 0)
2234 backend->default_printer = g_strdup (str);
2235 backend->got_default_printer = TRUE;
2239 /* Figure out user setting for default printer */
2240 cups_get_user_default_printer (&name);
2243 backend->default_printer = name;
2244 backend->got_default_printer = TRUE;
2250 cups_request_default_printer_cb (GtkPrintBackendCups *print_backend,
2251 GtkCupsResult *result,
2255 ipp_attribute_t *attr;
2256 GtkPrinter *printer;
2258 GDK_THREADS_ENTER ();
2260 if (gtk_cups_result_is_error (result))
2262 if (gtk_cups_result_get_error_type (result) == GTK_CUPS_ERROR_AUTH &&
2263 gtk_cups_result_get_error_code (result) == 1)
2265 /* Canceled by user, stop popping up more password dialogs */
2266 if (print_backend->list_printers_poll > 0)
2267 g_source_remove (print_backend->list_printers_poll);
2268 print_backend->list_printers_poll = 0;
2274 response = gtk_cups_result_get_response (result);
2276 if ((attr = ippFindAttribute (response, "printer-name", IPP_TAG_NAME)) != NULL)
2277 print_backend->default_printer = g_strdup (attr->values[0].string.text);
2279 print_backend->got_default_printer = TRUE;
2281 if (print_backend->default_printer != NULL)
2283 printer = gtk_print_backend_find_printer (GTK_PRINT_BACKEND (print_backend), print_backend->default_printer);
2284 if (printer != NULL)
2286 gtk_printer_set_is_default (printer, TRUE);
2287 g_signal_emit_by_name (GTK_PRINT_BACKEND (print_backend), "printer-status-changed", printer);
2291 /* Make sure to kick off get_printers if we are polling it,
2292 * as we could have blocked this reading the default printer
2294 if (print_backend->list_printers_poll != 0)
2295 cups_request_printer_list (print_backend);
2297 GDK_THREADS_LEAVE ();
2301 cups_request_default_printer (GtkPrintBackendCups *print_backend)
2303 GtkCupsConnectionState state;
2304 GtkCupsRequest *request;
2306 state = gtk_cups_connection_test_get_state (print_backend->cups_connection_test);
2307 update_backend_status (print_backend, state);
2309 if (state == GTK_CUPS_CONNECTION_IN_PROGRESS || state == GTK_CUPS_CONNECTION_NOT_AVAILABLE)
2312 request = gtk_cups_request_new_with_username (NULL,
2318 print_backend->username);
2320 cups_request_execute (print_backend,
2322 (GtkPrintCupsResponseCallbackFunc) cups_request_default_printer_cb,
2323 g_object_ref (print_backend),
2330 cups_printer_request_details (GtkPrinter *printer)
2332 GtkPrinterCups *cups_printer;
2334 cups_printer = GTK_PRINTER_CUPS (printer);
2335 if (!cups_printer->reading_ppd &&
2336 gtk_printer_cups_get_ppd (cups_printer) == NULL)
2337 cups_request_ppd (printer);
2341 ppd_text_to_utf8 (ppd_file_t *ppd_file,
2344 const char *encoding = NULL;
2347 if (g_ascii_strcasecmp (ppd_file->lang_encoding, "UTF-8") == 0)
2349 return g_strdup (text);
2351 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "ISOLatin1") == 0)
2353 encoding = "ISO-8859-1";
2355 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "ISOLatin2") == 0)
2357 encoding = "ISO-8859-2";
2359 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "ISOLatin5") == 0)
2361 encoding = "ISO-8859-5";
2363 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "JIS83-RKSJ") == 0)
2365 encoding = "SHIFT-JIS";
2367 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "MacStandard") == 0)
2369 encoding = "MACINTOSH";
2371 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "WindowsANSI") == 0)
2373 encoding = "WINDOWS-1252";
2377 /* Fallback, try iso-8859-1... */
2378 encoding = "ISO-8859-1";
2381 res = g_convert (text, -1, "UTF-8", encoding, NULL, NULL, NULL);
2386 g_warning ("CUPS Backend: Unable to convert PPD text\n"));
2387 res = g_strdup ("???");
2393 /* TODO: Add more translations for common settings here */
2395 static const struct {
2396 const char *keyword;
2397 const char *translation;
2398 } cups_option_translations[] = {
2399 { "Duplex", N_("Two Sided") },
2400 { "MediaType", N_("Paper Type") },
2401 { "InputSlot", N_("Paper Source") },
2402 { "OutputBin", N_("Output Tray") },
2403 { "Resolution", N_("Resolution") },
2404 { "PreFilter", N_("GhostScript pre-filtering") },
2408 static const struct {
2409 const char *keyword;
2411 const char *translation;
2412 } cups_choice_translations[] = {
2413 { "Duplex", "None", N_("One Sided") },
2414 /* Translators: this is an option of "Two Sided" */
2415 { "Duplex", "DuplexNoTumble", N_("Long Edge (Standard)") },
2416 /* Translators: this is an option of "Two Sided" */
2417 { "Duplex", "DuplexTumble", N_("Short Edge (Flip)") },
2418 /* Translators: this is an option of "Paper Source" */
2419 { "InputSlot", "Auto", N_("Auto Select") },
2420 /* Translators: this is an option of "Paper Source" */
2421 { "InputSlot", "AutoSelect", N_("Auto Select") },
2422 /* Translators: this is an option of "Paper Source" */
2423 { "InputSlot", "Default", N_("Printer Default") },
2424 /* Translators: this is an option of "Paper Source" */
2425 { "InputSlot", "None", N_("Printer Default") },
2426 /* Translators: this is an option of "Paper Source" */
2427 { "InputSlot", "PrinterDefault", N_("Printer Default") },
2428 /* Translators: this is an option of "Paper Source" */
2429 { "InputSlot", "Unspecified", N_("Auto Select") },
2430 /* Translators: this is an option of "Resolution" */
2431 { "Resolution", "default", N_("Printer Default") },
2432 /* Translators: this is an option of "GhostScript" */
2433 { "PreFilter", "EmbedFonts", N_("Embed GhostScript fonts only") },
2434 /* Translators: this is an option of "GhostScript" */
2435 { "PreFilter", "Level1", N_("Convert to PS level 1") },
2436 /* Translators: this is an option of "GhostScript" */
2437 { "PreFilter", "Level2", N_("Convert to PS level 2") },
2438 /* Translators: this is an option of "GhostScript" */
2439 { "PreFilter", "No", N_("No pre-filtering") },
2442 static const struct {
2444 const char *translation;
2445 } cups_group_translations[] = {
2446 /* Translators: "Miscellaneous" is the label for a button, that opens
2447 up an extra panel of settings in a print dialog. */
2448 { "Miscellaneous", N_("Miscellaneous") },
2451 static const struct {
2452 const char *ppd_keyword;
2454 } option_names[] = {
2455 {"Duplex", "gtk-duplex" },
2456 {"MediaType", "gtk-paper-type"},
2457 {"InputSlot", "gtk-paper-source"},
2458 {"OutputBin", "gtk-output-tray"},
2461 /* keep sorted when changing */
2462 static const char *color_option_whitelist[] = {
2463 "BRColorEnhancement",
2469 "BlackSubstitution",
2477 "RPSBlackOverPrint",
2481 /* keep sorted when changing */
2482 static const char *color_group_whitelist[] = {
2489 "HPColorOptionsPanel",
2492 /* keep sorted when changing */
2493 static const char *image_quality_option_whitelist[] = {
2495 "BRHalfTonePattern",
2505 "HPGraphicsHalftone",
2520 /* keep sorted when changing */
2521 static const char *image_quality_group_whitelist[] = {
2528 /* keep sorted when changing */
2529 static const char * finishing_option_whitelist[] = {
2542 "StapleOrientation",
2548 /* keep sorted when changing */
2549 static const char *finishing_group_whitelist[] = {
2558 /* keep sorted when changing */
2559 static const char *cups_option_blacklist[] = {
2568 get_option_text (ppd_file_t *ppd_file,
2569 ppd_option_t *option)
2574 for (i = 0; i < G_N_ELEMENTS (cups_option_translations); i++)
2576 if (strcmp (cups_option_translations[i].keyword, option->keyword) == 0)
2577 return g_strdup (_(cups_option_translations[i].translation));
2580 utf8 = ppd_text_to_utf8 (ppd_file, option->text);
2582 /* Some ppd files have spaces in the text before the colon */
2589 get_choice_text (ppd_file_t *ppd_file,
2590 ppd_choice_t *choice)
2593 ppd_option_t *option = choice->option;
2594 const char *keyword = option->keyword;
2596 for (i = 0; i < G_N_ELEMENTS (cups_choice_translations); i++)
2598 if (strcmp (cups_choice_translations[i].keyword, keyword) == 0 &&
2599 strcmp (cups_choice_translations[i].choice, choice->choice) == 0)
2600 return g_strdup (_(cups_choice_translations[i].translation));
2602 return ppd_text_to_utf8 (ppd_file, choice->text);
2606 group_has_option (ppd_group_t *group,
2607 ppd_option_t *option)
2614 if (group->num_options > 0 &&
2615 option >= group->options && option < group->options + group->num_options)
2618 for (i = 0; i < group->num_subgroups; i++)
2620 if (group_has_option (&group->subgroups[i],option))
2627 set_option_off (GtkPrinterOption *option)
2629 /* Any of these will do, _set only applies the value
2630 * if its allowed of the option */
2631 gtk_printer_option_set (option, "False");
2632 gtk_printer_option_set (option, "Off");
2633 gtk_printer_option_set (option, "None");
2637 value_is_off (const char *value)
2639 return (strcasecmp (value, "None") == 0 ||
2640 strcasecmp (value, "Off") == 0 ||
2641 strcasecmp (value, "False") == 0);
2645 ppd_group_name (ppd_group_t *group)
2647 #if CUPS_VERSION_MAJOR > 1 || (CUPS_VERSION_MAJOR == 1 && CUPS_VERSION_MINOR > 1) || (CUPS_VERSION_MAJOR == 1 && CUPS_VERSION_MINOR == 1 && CUPS_VERSION_PATCH >= 18)
2655 available_choices (ppd_file_t *ppd,
2656 ppd_option_t *option,
2657 ppd_choice_t ***available,
2658 gboolean keep_if_only_one_option)
2660 ppd_option_t *other_option;
2663 ppd_const_t *constraint;
2664 const char *choice, *other_choice;
2665 ppd_option_t *option1, *option2;
2666 ppd_group_t *installed_options;
2668 gboolean all_default;
2674 conflicts = g_new0 (char, option->num_choices);
2676 installed_options = NULL;
2677 for (i = 0; i < ppd->num_groups; i++)
2681 name = ppd_group_name (&ppd->groups[i]);
2682 if (strcmp (name, "InstallableOptions") == 0)
2684 installed_options = &ppd->groups[i];
2689 for (i = ppd->num_consts, constraint = ppd->consts; i > 0; i--, constraint++)
2691 option1 = ppdFindOption (ppd, constraint->option1);
2692 if (option1 == NULL)
2695 option2 = ppdFindOption (ppd, constraint->option2);
2696 if (option2 == NULL)
2699 if (option == option1)
2701 choice = constraint->choice1;
2702 other_option = option2;
2703 other_choice = constraint->choice2;
2705 else if (option == option2)
2707 choice = constraint->choice2;
2708 other_option = option1;
2709 other_choice = constraint->choice1;
2714 /* We only care of conflicts with installed_options and
2716 if (!group_has_option (installed_options, other_option) &&
2717 (strcmp (other_option->keyword, "PageSize") != 0))
2720 if (*other_choice == 0)
2722 /* Conflict only if the installed option is not off */
2723 if (value_is_off (other_option->defchoice))
2726 /* Conflict if the installed option has the specified default */
2727 else if (strcasecmp (other_choice, other_option->defchoice) != 0)
2732 /* Conflict with all non-off choices */
2733 for (j = 0; j < option->num_choices; j++)
2735 if (!value_is_off (option->choices[j].choice))
2741 for (j = 0; j < option->num_choices; j++)
2743 if (strcasecmp (option->choices[j].choice, choice) == 0)
2751 for (j = 0; j < option->num_choices; j++)
2755 else if (strcmp (option->choices[j].choice, option->defchoice) != 0)
2756 all_default = FALSE;
2759 if ((all_default && !keep_if_only_one_option) ||
2760 (num_conflicts == option->num_choices))
2767 /* Some ppds don't have a "use printer default" option for
2768 * InputSlot. This means you always have to select a particular slot,
2769 * and you can't auto-pick source based on the paper size. To support
2770 * this we always add an auto option if there isn't one already. If
2771 * the user chooses the generated option we don't send any InputSlot
2772 * value when printing. The way we detect existing auto-cases is based
2773 * on feedback from Michael Sweet of cups fame.
2776 if (strcmp (option->keyword, "InputSlot") == 0)
2778 gboolean found_auto = FALSE;
2779 for (j = 0; j < option->num_choices; j++)
2783 if (strcmp (option->choices[j].choice, "Auto") == 0 ||
2784 strcmp (option->choices[j].choice, "AutoSelect") == 0 ||
2785 strcmp (option->choices[j].choice, "Default") == 0 ||
2786 strcmp (option->choices[j].choice, "None") == 0 ||
2787 strcmp (option->choices[j].choice, "PrinterDefault") == 0 ||
2788 strcmp (option->choices[j].choice, "Unspecified") == 0 ||
2789 option->choices[j].code == NULL ||
2790 option->choices[j].code[0] == 0)
2804 *available = g_new (ppd_choice_t *, option->num_choices - num_conflicts + add_auto);
2807 for (j = 0; j < option->num_choices; j++)
2810 (*available)[i++] = &option->choices[j];
2814 (*available)[i++] = NULL;
2819 return option->num_choices - num_conflicts + add_auto;
2822 static GtkPrinterOption *
2823 create_pickone_option (ppd_file_t *ppd_file,
2824 ppd_option_t *ppd_option,
2825 const gchar *gtk_name)
2827 GtkPrinterOption *option;
2828 ppd_choice_t **available;
2832 #ifdef HAVE_CUPS_API_1_2
2833 ppd_coption_t *coption;
2836 g_assert (ppd_option->ui == PPD_UI_PICKONE);
2840 n_choices = available_choices (ppd_file, ppd_option, &available, g_str_has_prefix (gtk_name, "gtk-"));
2844 /* right now only support one parameter per custom option
2845 * if more than one print warning and only offer the default choices
2848 label = get_option_text (ppd_file, ppd_option);
2850 #ifdef HAVE_CUPS_API_1_2
2851 coption = ppdFindCustomOption (ppd_file, ppd_option->keyword);
2855 ppd_cparam_t *cparam;
2857 cparam = ppdFirstCustomParam (coption);
2859 if (ppdNextCustomParam (coption) == NULL)
2861 switch (cparam->type)
2863 case PPD_CUSTOM_INT:
2864 option = gtk_printer_option_new (gtk_name, label,
2865 GTK_PRINTER_OPTION_TYPE_PICKONE_INT);
2867 case PPD_CUSTOM_PASSCODE:
2868 option = gtk_printer_option_new (gtk_name, label,
2869 GTK_PRINTER_OPTION_TYPE_PICKONE_PASSCODE);
2871 case PPD_CUSTOM_PASSWORD:
2872 option = gtk_printer_option_new (gtk_name, label,
2873 GTK_PRINTER_OPTION_TYPE_PICKONE_PASSWORD);
2875 case PPD_CUSTOM_REAL:
2876 option = gtk_printer_option_new (gtk_name, label,
2877 GTK_PRINTER_OPTION_TYPE_PICKONE_REAL);
2879 case PPD_CUSTOM_STRING:
2880 option = gtk_printer_option_new (gtk_name, label,
2881 GTK_PRINTER_OPTION_TYPE_PICKONE_STRING);
2883 #ifdef PRINT_IGNORED_OPTIONS
2884 case PPD_CUSTOM_POINTS:
2885 g_warning ("CUPS Backend: PPD Custom Points Option not supported");
2887 case PPD_CUSTOM_CURVE:
2888 g_warning ("CUPS Backend: PPD Custom Curve Option not supported");
2890 case PPD_CUSTOM_INVCURVE:
2891 g_warning ("CUPS Backend: PPD Custom Inverse Curve Option not supported");
2898 #ifdef PRINT_IGNORED_OPTIONS
2900 g_warning ("CUPS Backend: Multi-parameter PPD Custom Option not supported");
2903 #endif /* HAVE_CUPS_API_1_2 */
2906 option = gtk_printer_option_new (gtk_name, label,
2907 GTK_PRINTER_OPTION_TYPE_PICKONE);
2910 gtk_printer_option_allocate_choices (option, n_choices);
2911 for (i = 0; i < n_choices; i++)
2913 if (available[i] == NULL)
2915 /* This was auto-added */
2916 option->choices[i] = g_strdup ("gtk-ignore-value");
2917 option->choices_display[i] = g_strdup (_("Printer Default"));
2921 option->choices[i] = g_strdup (available[i]->choice);
2922 option->choices_display[i] = get_choice_text (ppd_file, available[i]);
2925 gtk_printer_option_set (option, ppd_option->defchoice);
2927 #ifdef PRINT_IGNORED_OPTIONS
2929 g_warning ("CUPS Backend: Ignoring pickone %s\n", ppd_option->text);
2936 static GtkPrinterOption *
2937 create_boolean_option (ppd_file_t *ppd_file,
2938 ppd_option_t *ppd_option,
2939 const gchar *gtk_name)
2941 GtkPrinterOption *option;
2942 ppd_choice_t **available;
2946 g_assert (ppd_option->ui == PPD_UI_BOOLEAN);
2950 n_choices = available_choices (ppd_file, ppd_option, &available, g_str_has_prefix (gtk_name, "gtk-"));
2953 label = get_option_text (ppd_file, ppd_option);
2954 option = gtk_printer_option_new (gtk_name, label,
2955 GTK_PRINTER_OPTION_TYPE_BOOLEAN);
2958 gtk_printer_option_allocate_choices (option, 2);
2959 option->choices[0] = g_strdup ("True");
2960 option->choices_display[0] = g_strdup ("True");
2961 option->choices[1] = g_strdup ("False");
2962 option->choices_display[1] = g_strdup ("False");
2964 gtk_printer_option_set (option, ppd_option->defchoice);
2966 #ifdef PRINT_IGNORED_OPTIONS
2968 g_warning ("CUPS Backend: Ignoring boolean %s\n", ppd_option->text);
2976 get_option_name (const gchar *keyword)
2980 for (i = 0; i < G_N_ELEMENTS (option_names); i++)
2981 if (strcmp (option_names[i].ppd_keyword, keyword) == 0)
2982 return g_strdup (option_names[i].name);
2984 return g_strdup_printf ("cups-%s", keyword);
2988 strptr_cmp (const void *a,
2991 char **aa = (char **)a;
2992 char **bb = (char **)b;
2993 return strcmp (*aa, *bb);
2998 string_in_table (gchar *str,
2999 const gchar *table[],
3002 return bsearch (&str, table, table_len, sizeof (char *), (void *)strptr_cmp) != NULL;
3005 #define STRING_IN_TABLE(_str, _table) (string_in_table (_str, _table, G_N_ELEMENTS (_table)))
3008 handle_option (GtkPrinterOptionSet *set,
3009 ppd_file_t *ppd_file,
3010 ppd_option_t *ppd_option,
3011 ppd_group_t *toplevel_group,
3012 GtkPrintSettings *settings)
3014 GtkPrinterOption *option;
3018 if (STRING_IN_TABLE (ppd_option->keyword, cups_option_blacklist))
3021 name = get_option_name (ppd_option->keyword);
3024 if (ppd_option->ui == PPD_UI_PICKONE)
3026 option = create_pickone_option (ppd_file, ppd_option, name);
3028 else if (ppd_option->ui == PPD_UI_BOOLEAN)
3030 option = create_boolean_option (ppd_file, ppd_option, name);
3032 #ifdef PRINT_IGNORED_OPTIONS
3034 g_warning ("CUPS Backend: Ignoring pickmany setting %s\n", ppd_option->text);
3041 name = ppd_group_name (toplevel_group);
3042 if (STRING_IN_TABLE (name,
3043 color_group_whitelist) ||
3044 STRING_IN_TABLE (ppd_option->keyword,
3045 color_option_whitelist))
3047 option->group = g_strdup ("ColorPage");
3049 else if (STRING_IN_TABLE (name,
3050 image_quality_group_whitelist) ||
3051 STRING_IN_TABLE (ppd_option->keyword,
3052 image_quality_option_whitelist))
3054 option->group = g_strdup ("ImageQualityPage");
3056 else if (STRING_IN_TABLE (name,
3057 finishing_group_whitelist) ||
3058 STRING_IN_TABLE (ppd_option->keyword,
3059 finishing_option_whitelist))
3061 option->group = g_strdup ("FinishingPage");
3065 for (i = 0; i < G_N_ELEMENTS (cups_group_translations); i++)
3067 if (strcmp (cups_group_translations[i].name, toplevel_group->name) == 0)
3069 option->group = g_strdup (_(cups_group_translations[i].translation));
3074 if (i == G_N_ELEMENTS (cups_group_translations))
3075 option->group = g_strdup (toplevel_group->text);
3078 set_option_from_settings (option, settings);
3080 gtk_printer_option_set_add (set, option);
3087 handle_group (GtkPrinterOptionSet *set,
3088 ppd_file_t *ppd_file,
3090 ppd_group_t *toplevel_group,
3091 GtkPrintSettings *settings)
3096 /* Ignore installable options */
3097 name = ppd_group_name (toplevel_group);
3098 if (strcmp (name, "InstallableOptions") == 0)
3101 for (i = 0; i < group->num_options; i++)
3102 handle_option (set, ppd_file, &group->options[i], toplevel_group, settings);
3104 for (i = 0; i < group->num_subgroups; i++)
3105 handle_group (set, ppd_file, &group->subgroups[i], toplevel_group, settings);
3109 static GtkPrinterOptionSet *
3110 cups_printer_get_options (GtkPrinter *printer,
3111 GtkPrintSettings *settings,
3112 GtkPageSetup *page_setup,
3113 GtkPrintCapabilities capabilities)
3115 GtkPrinterOptionSet *set;
3116 GtkPrinterOption *option;
3117 ppd_file_t *ppd_file;
3119 char *print_at[] = { "now", "at", "on-hold" };
3120 char *n_up[] = {"1", "2", "4", "6", "9", "16" };
3121 char *prio[] = {"100", "80", "50", "30" };
3122 /* Translators: These strings name the possible values of the
3123 * job priority option in the print dialog
3125 char *prio_display[] = {N_("Urgent"), N_("High"), N_("Medium"), N_("Low") };
3126 char *n_up_layout[] = { "lrtb", "lrbt", "rltb", "rlbt", "tblr", "tbrl", "btlr", "btrl" };
3127 /* Translators: These strings name the possible arrangements of
3128 * multiple pages on a sheet when printing
3130 char *n_up_layout_display[] = { N_("Left to right, top to bottom"), N_("Left to right, bottom to top"),
3131 N_("Right to left, top to bottom"), N_("Right to left, bottom to top"),
3132 N_("Top to bottom, left to right"), N_("Top to bottom, right to left"),
3133 N_("Bottom to top, left to right"), N_("Bottom to top, right to left") };
3136 cups_option_t *opts = NULL;
3137 GtkPrintBackendCups *backend;
3138 GtkTextDirection text_direction;
3141 set = gtk_printer_option_set_new ();
3143 /* Cups specific, non-ppd related settings */
3145 /* Translators, this string is used to label the pages-per-sheet option
3146 * in the print dialog
3148 option = gtk_printer_option_new ("gtk-n-up", _("Pages per Sheet"), GTK_PRINTER_OPTION_TYPE_PICKONE);
3149 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (n_up),
3151 gtk_printer_option_set (option, "1");
3152 set_option_from_settings (option, settings);
3153 gtk_printer_option_set_add (set, option);
3154 g_object_unref (option);
3156 if (cups_printer_get_capabilities (printer) & GTK_PRINT_CAPABILITY_NUMBER_UP_LAYOUT)
3158 for (i = 0; i < G_N_ELEMENTS (n_up_layout_display); i++)
3159 n_up_layout_display[i] = _(n_up_layout_display[i]);
3161 /* Translators, this string is used to label the option in the print
3162 * dialog that controls in what order multiple pages are arranged
3164 option = gtk_printer_option_new ("gtk-n-up-layout", _("Page Ordering"), GTK_PRINTER_OPTION_TYPE_PICKONE);
3165 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (n_up_layout),
3166 n_up_layout, n_up_layout_display);
3168 text_direction = gtk_widget_get_default_direction ();
3169 if (text_direction == GTK_TEXT_DIR_LTR)
3170 gtk_printer_option_set (option, "lrtb");
3172 gtk_printer_option_set (option, "rltb");
3174 set_option_from_settings (option, settings);
3175 gtk_printer_option_set_add (set, option);
3176 g_object_unref (option);
3179 for (i = 0; i < G_N_ELEMENTS(prio_display); i++)
3180 prio_display[i] = _(prio_display[i]);
3182 /* Translators, this string is used to label the job priority option
3183 * in the print dialog
3185 option = gtk_printer_option_new ("gtk-job-prio", _("Job Priority"), GTK_PRINTER_OPTION_TYPE_PICKONE);
3186 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (prio),
3187 prio, prio_display);
3188 gtk_printer_option_set (option, "50");
3189 set_option_from_settings (option, settings);
3190 gtk_printer_option_set_add (set, option);
3191 g_object_unref (option);
3193 /* Translators, this string is used to label the billing info entry
3194 * in the print dialog
3196 option = gtk_printer_option_new ("gtk-billing-info", _("Billing Info"), GTK_PRINTER_OPTION_TYPE_STRING);
3197 gtk_printer_option_set (option, "");
3198 set_option_from_settings (option, settings);
3199 gtk_printer_option_set_add (set, option);
3200 g_object_unref (option);
3202 backend = GTK_PRINT_BACKEND_CUPS (gtk_printer_get_backend (printer));
3204 if (backend != NULL)
3206 char *cover_default[] = {"none", "classified", "confidential", "secret", "standard", "topsecret", "unclassified" };
3207 /* Translators, these strings are names for various 'standard' cover
3208 * pages that the printing system may support.
3210 char *cover_display_default[] = {N_("None"), N_("Classified"), N_("Confidential"), N_("Secret"), N_("Standard"), N_("Top Secret"), N_("Unclassified"),};
3211 char **cover = NULL;
3212 char **cover_display = NULL;
3213 char **cover_display_translated = NULL;
3214 gint num_of_covers = 0;
3218 num_of_covers = backend->number_of_covers;
3219 cover = g_new (char *, num_of_covers + 1);
3220 cover[num_of_covers] = NULL;
3221 cover_display = g_new (char *, num_of_covers + 1);
3222 cover_display[num_of_covers] = NULL;
3223 cover_display_translated = g_new (char *, num_of_covers + 1);
3224 cover_display_translated[num_of_covers] = NULL;
3226 for (i = 0; i < num_of_covers; i++)
3228 cover[i] = g_strdup (backend->covers[i]);
3230 for (j = 0; j < G_N_ELEMENTS (cover_default); j++)
3231 if (strcmp (cover_default[j], cover[i]) == 0)
3233 value = cover_display_default[j];
3236 cover_display[i] = (value != NULL) ? g_strdup (value) : g_strdup (backend->covers[i]);
3239 for (i = 0; i < num_of_covers; i++)
3240 cover_display_translated[i] = _(cover_display[i]);
3242 /* Translators, this is the label used for the option in the print
3243 * dialog that controls the front cover page.
3245 option = gtk_printer_option_new ("gtk-cover-before", _("Before"), GTK_PRINTER_OPTION_TYPE_PICKONE);
3246 gtk_printer_option_choices_from_array (option, num_of_covers,
3247 cover, cover_display_translated);
3249 if (backend->default_cover_before != NULL)
3250 gtk_printer_option_set (option, backend->default_cover_before);
3252 gtk_printer_option_set (option, "none");
3253 set_option_from_settings (option, settings);
3254 gtk_printer_option_set_add (set, option);
3255 g_object_unref (option);
3257 /* Translators, this is the label used for the option in the print
3258 * dialog that controls the back cover page.
3260 option = gtk_printer_option_new ("gtk-cover-after", _("After"), GTK_PRINTER_OPTION_TYPE_PICKONE);
3261 gtk_printer_option_choices_from_array (option, num_of_covers,
3262 cover, cover_display_translated);
3263 if (backend->default_cover_after != NULL)
3264 gtk_printer_option_set (option, backend->default_cover_after);
3266 gtk_printer_option_set (option, "none");
3267 set_option_from_settings (option, settings);
3268 gtk_printer_option_set_add (set, option);
3269 g_object_unref (option);
3272 g_strfreev (cover_display);
3273 g_free (cover_display_translated);
3276 /* Translators: this is the name of the option that controls when
3277 * a print job is printed. Possible values are 'now', a specified time,
3280 option = gtk_printer_option_new ("gtk-print-time", _("Print at"), GTK_PRINTER_OPTION_TYPE_PICKONE);
3281 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (print_at),
3282 print_at, print_at);
3283 gtk_printer_option_set (option, "now");
3284 set_option_from_settings (option, settings);
3285 gtk_printer_option_set_add (set, option);
3286 g_object_unref (option);
3288 /* Translators: this is the name of the option that allows the user
3289 * to specify a time when a print job will be printed.
3291 option = gtk_printer_option_new ("gtk-print-time-text", _("Print at time"), GTK_PRINTER_OPTION_TYPE_STRING);
3292 gtk_printer_option_set (option, "");
3293 set_option_from_settings (option, settings);
3294 gtk_printer_option_set_add (set, option);
3295 g_object_unref (option);
3297 /* Printer (ppd) specific settings */
3298 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
3301 GtkPaperSize *paper_size;
3302 ppd_option_t *option;
3303 const gchar *ppd_name;
3305 ppdMarkDefaults (ppd_file);
3307 paper_size = gtk_page_setup_get_paper_size (page_setup);
3309 option = ppdFindOption (ppd_file, "PageSize");
3310 ppd_name = gtk_paper_size_get_ppd_name (paper_size);
3313 strncpy (option->defchoice, ppd_name, PPD_MAX_NAME);
3317 char width[G_ASCII_DTOSTR_BUF_SIZE];
3318 char height[G_ASCII_DTOSTR_BUF_SIZE];
3320 g_ascii_formatd (width, sizeof (width), "%.2f", gtk_paper_size_get_width (paper_size, GTK_UNIT_POINTS));
3321 g_ascii_formatd (height, sizeof (height), "%.2f", gtk_paper_size_get_height (paper_size, GTK_UNIT_POINTS));
3322 /* Translators: this format is used to display a custom paper
3323 * size. The two placeholders are replaced with the width and height
3324 * in points. E.g: "Custom 230.4x142.9"
3326 custom_name = g_strdup_printf (_("Custom %sx%s"), width, height);
3327 strncpy (option->defchoice, custom_name, PPD_MAX_NAME);
3328 g_free (custom_name);
3331 for (i = 0; i < ppd_file->num_groups; i++)
3332 handle_group (set, ppd_file, &ppd_file->groups[i], &ppd_file->groups[i], settings);
3335 /* Now honor the user set defaults for this printer */
3336 num_opts = cups_get_user_options (gtk_printer_get_name (printer), 0, &opts);
3338 for (i = 0; i < num_opts; i++)
3340 if (STRING_IN_TABLE (opts[i].name, cups_option_blacklist))
3343 name = get_option_name (opts[i].name);
3344 option = gtk_printer_option_set_lookup (set, name);
3346 gtk_printer_option_set (option, opts[i].value);
3350 cupsFreeOptions (num_opts, opts);
3357 mark_option_from_set (GtkPrinterOptionSet *set,
3358 ppd_file_t *ppd_file,
3359 ppd_option_t *ppd_option)
3361 GtkPrinterOption *option;
3362 char *name = get_option_name (ppd_option->keyword);
3364 option = gtk_printer_option_set_lookup (set, name);
3367 ppdMarkOption (ppd_file, ppd_option->keyword, option->value);
3374 mark_group_from_set (GtkPrinterOptionSet *set,
3375 ppd_file_t *ppd_file,
3380 for (i = 0; i < group->num_options; i++)
3381 mark_option_from_set (set, ppd_file, &group->options[i]);
3383 for (i = 0; i < group->num_subgroups; i++)
3384 mark_group_from_set (set, ppd_file, &group->subgroups[i]);
3388 set_conflicts_from_option (GtkPrinterOptionSet *set,
3389 ppd_file_t *ppd_file,
3390 ppd_option_t *ppd_option)
3392 GtkPrinterOption *option;
3395 if (ppd_option->conflicted)
3397 name = get_option_name (ppd_option->keyword);
3398 option = gtk_printer_option_set_lookup (set, name);
3401 gtk_printer_option_set_has_conflict (option, TRUE);
3402 #ifdef PRINT_IGNORED_OPTIONS
3404 g_warning ("CUPS Backend: Ignoring conflict for option %s", ppd_option->keyword);
3412 set_conflicts_from_group (GtkPrinterOptionSet *set,
3413 ppd_file_t *ppd_file,
3418 for (i = 0; i < group->num_options; i++)
3419 set_conflicts_from_option (set, ppd_file, &group->options[i]);
3421 for (i = 0; i < group->num_subgroups; i++)
3422 set_conflicts_from_group (set, ppd_file, &group->subgroups[i]);
3426 cups_printer_mark_conflicts (GtkPrinter *printer,
3427 GtkPrinterOptionSet *options)
3429 ppd_file_t *ppd_file;
3433 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
3435 if (ppd_file == NULL)
3438 ppdMarkDefaults (ppd_file);
3440 for (i = 0; i < ppd_file->num_groups; i++)
3441 mark_group_from_set (options, ppd_file, &ppd_file->groups[i]);
3443 num_conflicts = ppdConflicts (ppd_file);
3445 if (num_conflicts > 0)
3447 for (i = 0; i < ppd_file->num_groups; i++)
3448 set_conflicts_from_group (options, ppd_file, &ppd_file->groups[i]);
3451 return num_conflicts > 0;
3455 GtkPrinter *printer;
3456 GtkPrinterOptionSet *options;
3457 GtkPrintSettings *settings;
3458 ppd_file_t *ppd_file;
3463 const char *standard;
3467 map_settings_to_option (GtkPrinterOption *option,
3468 const NameMapping table[],
3470 GtkPrintSettings *settings,
3471 const gchar *standard_name,
3472 const gchar *cups_name)
3476 const char *cups_value;
3477 const char *standard_value;
3479 /* If the cups-specific setting is set, always use that */
3480 name = g_strdup_printf ("cups-%s", cups_name);
3481 cups_value = gtk_print_settings_get (settings, name);
3484 if (cups_value != NULL)
3486 gtk_printer_option_set (option, cups_value);
3490 /* Otherwise we try to convert from the general setting */
3491 standard_value = gtk_print_settings_get (settings, standard_name);
3492 if (standard_value == NULL)
3495 for (i = 0; i < n_elements; i++)
3497 if (table[i].cups == NULL && table[i].standard == NULL)
3499 gtk_printer_option_set (option, standard_value);
3502 else if (table[i].cups == NULL &&
3503 strcmp (table[i].standard, standard_value) == 0)
3505 set_option_off (option);
3508 else if (strcmp (table[i].standard, standard_value) == 0)
3510 gtk_printer_option_set (option, table[i].cups);
3517 map_option_to_settings (const gchar *value,
3518 const NameMapping table[],
3520 GtkPrintSettings *settings,
3521 const gchar *standard_name,
3522 const gchar *cups_name)
3527 for (i = 0; i < n_elements; i++)
3529 if (table[i].cups == NULL && table[i].standard == NULL)
3531 gtk_print_settings_set (settings,
3536 else if (table[i].cups == NULL && table[i].standard != NULL)
3538 if (value_is_off (value))
3540 gtk_print_settings_set (settings,
3546 else if (strcmp (table[i].cups, value) == 0)
3548 gtk_print_settings_set (settings,
3555 /* Always set the corresponding cups-specific setting */
3556 name = g_strdup_printf ("cups-%s", cups_name);
3557 gtk_print_settings_set (settings, name, value);
3562 static const NameMapping paper_source_map[] = {
3563 { "Lower", "lower"},
3564 { "Middle", "middle"},
3565 { "Upper", "upper"},
3567 { "Envelope", "envelope"},
3568 { "Cassette", "cassette"},
3569 { "LargeCapacity", "large-capacity"},
3570 { "AnySmallFormat", "small-format"},
3571 { "AnyLargeFormat", "large-format"},
3575 static const NameMapping output_tray_map[] = {
3576 { "Upper", "upper"},
3577 { "Lower", "lower"},
3582 static const NameMapping duplex_map[] = {
3583 { "DuplexTumble", "vertical" },
3584 { "DuplexNoTumble", "horizontal" },
3588 static const NameMapping output_mode_map[] = {
3589 { "Standard", "normal" },
3590 { "Normal", "normal" },
3591 { "Draft", "draft" },
3592 { "Fast", "draft" },
3595 static const NameMapping media_type_map[] = {
3596 { "Transparency", "transparency"},
3597 { "Standard", "stationery"},
3601 static const NameMapping all_map[] = {
3607 set_option_from_settings (GtkPrinterOption *option,
3608 GtkPrintSettings *settings)
3610 const char *cups_value;
3613 if (settings == NULL)
3616 if (strcmp (option->name, "gtk-paper-source") == 0)
3617 map_settings_to_option (option, paper_source_map, G_N_ELEMENTS (paper_source_map),
3618 settings, GTK_PRINT_SETTINGS_DEFAULT_SOURCE, "InputSlot");
3619 else if (strcmp (option->name, "gtk-output-tray") == 0)
3620 map_settings_to_option (option, output_tray_map, G_N_ELEMENTS (output_tray_map),
3621 settings, GTK_PRINT_SETTINGS_OUTPUT_BIN, "OutputBin");
3622 else if (strcmp (option->name, "gtk-duplex") == 0)
3623 map_settings_to_option (option, duplex_map, G_N_ELEMENTS (duplex_map),
3624 settings, GTK_PRINT_SETTINGS_DUPLEX, "Duplex");
3625 else if (strcmp (option->name, "cups-OutputMode") == 0)
3626 map_settings_to_option (option, output_mode_map, G_N_ELEMENTS (output_mode_map),
3627 settings, GTK_PRINT_SETTINGS_QUALITY, "OutputMode");
3628 else if (strcmp (option->name, "cups-Resolution") == 0)
3630 cups_value = gtk_print_settings_get (settings, option->name);
3632 gtk_printer_option_set (option, cups_value);
3635 int res = gtk_print_settings_get_resolution (settings);
3636 int res_x = gtk_print_settings_get_resolution_x (settings);
3637 int res_y = gtk_print_settings_get_resolution_y (settings);
3641 value = g_strdup_printf ("%dx%ddpi", res_x, res_y);
3642 gtk_printer_option_set (option, value);
3647 value = g_strdup_printf ("%ddpi", res);
3648 gtk_printer_option_set (option, value);
3653 else if (strcmp (option->name, "gtk-paper-type") == 0)
3654 map_settings_to_option (option, media_type_map, G_N_ELEMENTS (media_type_map),
3655 settings, GTK_PRINT_SETTINGS_MEDIA_TYPE, "MediaType");
3656 else if (strcmp (option->name, "gtk-n-up") == 0)
3658 map_settings_to_option (option, all_map, G_N_ELEMENTS (all_map),
3659 settings, GTK_PRINT_SETTINGS_NUMBER_UP, "number-up");
3661 else if (strcmp (option->name, "gtk-n-up-layout") == 0)
3663 map_settings_to_option (option, all_map, G_N_ELEMENTS (all_map),
3664 settings, GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT, "number-up-layout");
3666 else if (strcmp (option->name, "gtk-billing-info") == 0)
3668 cups_value = gtk_print_settings_get (settings, "cups-job-billing");
3670 gtk_printer_option_set (option, cups_value);
3672 else if (strcmp (option->name, "gtk-job-prio") == 0)
3674 cups_value = gtk_print_settings_get (settings, "cups-job-priority");
3676 gtk_printer_option_set (option, cups_value);
3678 else if (strcmp (option->name, "gtk-cover-before") == 0)
3680 cups_value = gtk_print_settings_get (settings, "cover-before");
3682 gtk_printer_option_set (option, cups_value);
3684 else if (strcmp (option->name, "gtk-cover-after") == 0)
3686 cups_value = gtk_print_settings_get (settings, "cover-after");
3688 gtk_printer_option_set (option, cups_value);
3690 else if (strcmp (option->name, "gtk-print-time") == 0)
3692 cups_value = gtk_print_settings_get (settings, "print-at");
3694 gtk_printer_option_set (option, cups_value);
3696 else if (strcmp (option->name, "gtk-print-time-text") == 0)
3698 cups_value = gtk_print_settings_get (settings, "print-at-time");
3700 gtk_printer_option_set (option, cups_value);
3702 else if (g_str_has_prefix (option->name, "cups-"))
3704 cups_value = gtk_print_settings_get (settings, option->name);
3706 gtk_printer_option_set (option, cups_value);
3711 foreach_option_get_settings (GtkPrinterOption *option,
3714 struct OptionData *data = user_data;
3715 GtkPrintSettings *settings = data->settings;
3718 value = option->value;
3720 if (strcmp (option->name, "gtk-paper-source") == 0)
3721 map_option_to_settings (value, paper_source_map, G_N_ELEMENTS (paper_source_map),
3722 settings, GTK_PRINT_SETTINGS_DEFAULT_SOURCE, "InputSlot");
3723 else if (strcmp (option->name, "gtk-output-tray") == 0)
3724 map_option_to_settings (value, output_tray_map, G_N_ELEMENTS (output_tray_map),
3725 settings, GTK_PRINT_SETTINGS_OUTPUT_BIN, "OutputBin");
3726 else if (strcmp (option->name, "gtk-duplex") == 0)
3727 map_option_to_settings (value, duplex_map, G_N_ELEMENTS (duplex_map),
3728 settings, GTK_PRINT_SETTINGS_DUPLEX, "Duplex");
3729 else if (strcmp (option->name, "cups-OutputMode") == 0)
3730 map_option_to_settings (value, output_mode_map, G_N_ELEMENTS (output_mode_map),
3731 settings, GTK_PRINT_SETTINGS_QUALITY, "OutputMode");
3732 else if (strcmp (option->name, "cups-Resolution") == 0)
3734 int res, res_x, res_y;
3736 if (sscanf (value, "%dx%ddpi", &res_x, &res_y) == 2)
3738 if (res_x != 0 && res_y != 0)
3739 gtk_print_settings_set_resolution_xy (settings, res_x, res_y);
3741 else if (sscanf (value, "%ddpi", &res) == 1)
3744 gtk_print_settings_set_resolution (settings, res);
3747 gtk_print_settings_set (settings, option->name, value);
3749 else if (strcmp (option->name, "gtk-paper-type") == 0)
3750 map_option_to_settings (value, media_type_map, G_N_ELEMENTS (media_type_map),
3751 settings, GTK_PRINT_SETTINGS_MEDIA_TYPE, "MediaType");
3752 else if (strcmp (option->name, "gtk-n-up") == 0)
3753 map_option_to_settings (value, all_map, G_N_ELEMENTS (all_map),
3754 settings, GTK_PRINT_SETTINGS_NUMBER_UP, "number-up");
3755 else if (strcmp (option->name, "gtk-n-up-layout") == 0)
3756 map_option_to_settings (value, all_map, G_N_ELEMENTS (all_map),
3757 settings, GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT, "number-up-layout");
3758 else if (strcmp (option->name, "gtk-billing-info") == 0 && strlen (value) > 0)
3759 gtk_print_settings_set (settings, "cups-job-billing", value);
3760 else if (strcmp (option->name, "gtk-job-prio") == 0)
3761 gtk_print_settings_set (settings, "cups-job-priority", value);
3762 else if (strcmp (option->name, "gtk-cover-before") == 0)
3763 gtk_print_settings_set (settings, "cover-before", value);
3764 else if (strcmp (option->name, "gtk-cover-after") == 0)
3765 gtk_print_settings_set (settings, "cover-after", value);
3766 else if (strcmp (option->name, "gtk-print-time") == 0)
3767 gtk_print_settings_set (settings, "print-at", value);
3768 else if (strcmp (option->name, "gtk-print-time-text") == 0)
3769 gtk_print_settings_set (settings, "print-at-time", value);
3770 else if (g_str_has_prefix (option->name, "cups-"))
3771 gtk_print_settings_set (settings, option->name, value);
3775 supports_am_pm (void)
3777 struct tm tmp_tm = { 0 };
3781 length = strftime (time, sizeof (time), "%p", &tmp_tm);
3786 /* Converts local time to UTC time. Local time has to be in one of these
3787 * formats: HH:MM:SS, HH:MM, HH:MM:SS {am, pm}, HH:MM {am, pm}, HH {am, pm},
3788 * {am, pm} HH:MM:SS, {am, pm} HH:MM, {am, pm} HH.
3789 * Returns a newly allocated string holding UTC time in HH:MM:SS format
3793 localtime_to_utctime (const char *local_time)
3795 const char *formats_0[] = {" %I : %M : %S %p ", " %p %I : %M : %S ",
3797 " %I : %M %p ", " %p %I : %M ",
3799 " %I %p ", " %p %I "};
3800 const char *formats_1[] = {" %H : %M : %S ", " %H : %M "};
3801 const char *end = NULL;
3802 struct tm *actual_local_time;
3803 struct tm *actual_utc_time;
3804 struct tm local_print_time;
3805 struct tm utc_print_time;
3806 struct tm diff_time;
3807 gchar *utc_time = NULL;
3810 if (local_time == NULL || local_time[0] == '\0')
3813 n = supports_am_pm () ? G_N_ELEMENTS (formats_0) : G_N_ELEMENTS (formats_1);
3815 for (i = 0; i < n; i++)
3817 local_print_time.tm_hour = 0;
3818 local_print_time.tm_min = 0;
3819 local_print_time.tm_sec = 0;
3821 if (supports_am_pm ())
3822 end = strptime (local_time, formats_0[i], &local_print_time);
3824 end = strptime (local_time, formats_1[i], &local_print_time);
3826 if (end != NULL && end[0] == '\0')
3830 if (end != NULL && end[0] == '\0')
3835 actual_utc_time = g_memdup (gmtime (&rawtime), sizeof (struct tm));
3836 actual_local_time = g_memdup (localtime (&rawtime), sizeof (struct tm));
3838 diff_time.tm_hour = actual_utc_time->tm_hour - actual_local_time->tm_hour;
3839 diff_time.tm_min = actual_utc_time->tm_min - actual_local_time->tm_min;
3840 diff_time.tm_sec = actual_utc_time->tm_sec - actual_local_time->tm_sec;
3842 utc_print_time.tm_hour = ((local_print_time.tm_hour + diff_time.tm_hour) + 24) % 24;
3843 utc_print_time.tm_min = ((local_print_time.tm_min + diff_time.tm_min) + 60) % 60;
3844 utc_print_time.tm_sec = ((local_print_time.tm_sec + diff_time.tm_sec) + 60) % 60;
3846 utc_time = g_strdup_printf ("%02d:%02d:%02d",
3847 utc_print_time.tm_hour,
3848 utc_print_time.tm_min,
3849 utc_print_time.tm_sec);
3856 cups_printer_get_settings_from_options (GtkPrinter *printer,
3857 GtkPrinterOptionSet *options,
3858 GtkPrintSettings *settings)
3860 struct OptionData data;
3861 const char *print_at, *print_at_time;
3863 data.printer = printer;
3864 data.options = options;
3865 data.settings = settings;
3866 data.ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
3868 if (data.ppd_file != NULL)
3870 GtkPrinterOption *cover_before, *cover_after;
3872 gtk_printer_option_set_foreach (options, foreach_option_get_settings, &data);
3874 cover_before = gtk_printer_option_set_lookup (options, "gtk-cover-before");
3875 cover_after = gtk_printer_option_set_lookup (options, "gtk-cover-after");
3876 if (cover_before && cover_after)
3878 char *value = g_strdup_printf ("%s,%s", cover_before->value, cover_after->value);
3879 gtk_print_settings_set (settings, "cups-job-sheets", value);
3883 print_at = gtk_print_settings_get (settings, "print-at");
3884 print_at_time = gtk_print_settings_get (settings, "print-at-time");
3886 if (strcmp (print_at, "at") == 0)
3888 gchar *utc_time = NULL;
3890 utc_time = localtime_to_utctime (print_at_time);
3892 if (utc_time != NULL)
3894 gtk_print_settings_set (settings, "cups-job-hold-until", utc_time);
3898 gtk_print_settings_set (settings, "cups-job-hold-until", print_at_time);
3900 else if (strcmp (print_at, "on-hold") == 0)
3901 gtk_print_settings_set (settings, "cups-job-hold-until", "indefinite");
3906 cups_printer_prepare_for_print (GtkPrinter *printer,
3907 GtkPrintJob *print_job,
3908 GtkPrintSettings *settings,
3909 GtkPageSetup *page_setup)
3911 GtkPageSet page_set;
3912 GtkPaperSize *paper_size;
3913 const char *ppd_paper_name;
3916 print_job->print_pages = gtk_print_settings_get_print_pages (settings);
3917 print_job->page_ranges = NULL;
3918 print_job->num_page_ranges = 0;
3920 if (print_job->print_pages == GTK_PRINT_PAGES_RANGES)
3921 print_job->page_ranges =
3922 gtk_print_settings_get_page_ranges (settings,
3923 &print_job->num_page_ranges);
3925 if (gtk_print_settings_get_collate (settings))
3926 gtk_print_settings_set (settings, "cups-Collate", "True");
3927 print_job->collate = FALSE;
3929 if (gtk_print_settings_get_reverse (settings))
3930 gtk_print_settings_set (settings, "cups-OutputOrder", "Reverse");
3931 print_job->reverse = FALSE;
3933 if (gtk_print_settings_get_n_copies (settings) > 1)
3934 gtk_print_settings_set_int (settings, "cups-copies",
3935 gtk_print_settings_get_n_copies (settings));
3936 print_job->num_copies = 1;
3938 scale = gtk_print_settings_get_scale (settings);
3939 print_job->scale = 1.0;
3941 print_job->scale = scale/100.0;
3943 page_set = gtk_print_settings_get_page_set (settings);
3944 if (page_set == GTK_PAGE_SET_EVEN)
3945 gtk_print_settings_set (settings, "cups-page-set", "even");
3946 else if (page_set == GTK_PAGE_SET_ODD)
3947 gtk_print_settings_set (settings, "cups-page-set", "odd");
3948 print_job->page_set = GTK_PAGE_SET_ALL;
3950 paper_size = gtk_page_setup_get_paper_size (page_setup);
3951 ppd_paper_name = gtk_paper_size_get_ppd_name (paper_size);
3952 if (ppd_paper_name != NULL)
3953 gtk_print_settings_set (settings, "cups-PageSize", ppd_paper_name);
3956 char width[G_ASCII_DTOSTR_BUF_SIZE];
3957 char height[G_ASCII_DTOSTR_BUF_SIZE];
3960 g_ascii_formatd (width, sizeof (width), "%.2f", gtk_paper_size_get_width (paper_size, GTK_UNIT_POINTS));
3961 g_ascii_formatd (height, sizeof (height), "%.2f", gtk_paper_size_get_height (paper_size, GTK_UNIT_POINTS));
3962 custom_name = g_strdup_printf (("Custom.%sx%s"), width, height);
3963 gtk_print_settings_set (settings, "cups-PageSize", custom_name);
3964 g_free (custom_name);
3967 print_job->rotate_to_orientation = TRUE;
3970 static GtkPageSetup *
3971 create_page_setup (ppd_file_t *ppd_file,
3975 GtkPageSetup *page_setup;
3976 GtkPaperSize *paper_size;
3977 ppd_option_t *option;
3978 ppd_choice_t *choice;
3980 display_name = NULL;
3981 option = ppdFindOption (ppd_file, "PageSize");
3984 choice = ppdFindChoice (option, size->name);
3986 display_name = ppd_text_to_utf8 (ppd_file, choice->text);
3989 if (display_name == NULL)
3990 display_name = g_strdup (size->name);
3992 page_setup = gtk_page_setup_new ();
3993 paper_size = gtk_paper_size_new_from_ppd (size->name,
3997 gtk_page_setup_set_paper_size (page_setup, paper_size);
3998 gtk_paper_size_free (paper_size);
4000 gtk_page_setup_set_top_margin (page_setup, size->length - size->top, GTK_UNIT_POINTS);
4001 gtk_page_setup_set_bottom_margin (page_setup, size->bottom, GTK_UNIT_POINTS);
4002 gtk_page_setup_set_left_margin (page_setup, size->left, GTK_UNIT_POINTS);
4003 gtk_page_setup_set_right_margin (page_setup, size->width - size->right, GTK_UNIT_POINTS);
4005 g_free (display_name);
4011 cups_printer_list_papers (GtkPrinter *printer)
4013 ppd_file_t *ppd_file;
4015 GtkPageSetup *page_setup;
4019 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
4020 if (ppd_file == NULL)
4025 for (i = 0; i < ppd_file->num_sizes; i++)
4027 size = &ppd_file->sizes[i];
4029 page_setup = create_page_setup (ppd_file, size);
4031 l = g_list_prepend (l, page_setup);
4034 return g_list_reverse (l);
4037 static GtkPageSetup *
4038 cups_printer_get_default_page_size (GtkPrinter *printer)
4040 ppd_file_t *ppd_file;
4042 ppd_option_t *option;
4045 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
4046 if (ppd_file == NULL)
4049 option = ppdFindOption (ppd_file, "PageSize");
4050 size = ppdPageSize (ppd_file, option->defchoice);
4052 return create_page_setup (ppd_file, size);
4056 cups_printer_get_hard_margins (GtkPrinter *printer,
4062 ppd_file_t *ppd_file;
4064 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
4065 if (ppd_file == NULL)
4068 *left = ppd_file->custom_margins[0];
4069 *bottom = ppd_file->custom_margins[1];
4070 *right = ppd_file->custom_margins[2];
4071 *top = ppd_file->custom_margins[3];
4074 static GtkPrintCapabilities
4075 cups_printer_get_capabilities (GtkPrinter *printer)
4078 GTK_PRINT_CAPABILITY_COPIES |
4079 GTK_PRINT_CAPABILITY_COLLATE |
4080 GTK_PRINT_CAPABILITY_REVERSE |
4081 #if (CUPS_VERSION_MAJOR == 1 && CUPS_VERSION_MINOR >= 1 && CUPS_VERSION_PATCH >= 15) || (CUPS_VERSION_MAJOR == 1 && CUPS_VERSION_MINOR > 1) || CUPS_VERSION_MAJOR > 1
4082 GTK_PRINT_CAPABILITY_NUMBER_UP_LAYOUT |
4084 GTK_PRINT_CAPABILITY_NUMBER_UP;