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.
25 #include <sys/types.h>
29 #include <cups/cups.h>
30 #include <cups/language.h>
31 #include <cups/http.h>
35 #include <cairo-pdf.h>
38 #include <glib/gstdio.h>
39 #include <glib/gi18n-lib.h>
43 #include <gtk/gtkprintbackend.h>
44 #include <gtk/gtkunixprint.h>
45 #include <gtk/gtkprinter-private.h>
47 #include "gtkprintbackendcups.h"
48 #include "gtkprintercups.h"
50 #include "gtkcupsutils.h"
53 typedef struct _GtkPrintBackendCupsClass GtkPrintBackendCupsClass;
55 #define GTK_PRINT_BACKEND_CUPS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_BACKEND_CUPS, GtkPrintBackendCupsClass))
56 #define GTK_IS_PRINT_BACKEND_CUPS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_BACKEND_CUPS))
57 #define GTK_PRINT_BACKEND_CUPS_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_BACKEND_CUPS, GtkPrintBackendCupsClass))
59 #define _CUPS_MAX_ATTEMPTS 10
60 #define _CUPS_MAX_CHUNK_SIZE 8192
62 /* define this to see warnings about ignored ppd options */
63 #undef PRINT_IGNORED_OPTIONS
65 #define _CUPS_MAP_ATTR_INT(attr, v, a) {if (!g_ascii_strcasecmp (attr->name, (a))) v = attr->values[0].integer;}
66 #define _CUPS_MAP_ATTR_STR(attr, v, a) {if (!g_ascii_strcasecmp (attr->name, (a))) v = attr->values[0].string.text;}
68 static GType print_backend_cups_type = 0;
70 typedef void (* GtkPrintCupsResponseCallbackFunc) (GtkPrintBackend *print_backend,
71 GtkCupsResult *result,
82 } GtkPrintCupsDispatchState;
89 GtkCupsRequest *request;
91 GtkPrintBackendCups *backend;
93 } GtkPrintCupsDispatchWatch;
95 struct _GtkPrintBackendCupsClass
97 GtkPrintBackendClass parent_class;
100 struct _GtkPrintBackendCups
102 GtkPrintBackend parent_instance;
104 char *default_printer;
106 guint list_printers_poll;
107 guint list_printers_pending : 1;
108 guint got_default_printer : 1;
111 char *default_cover_before;
112 char *default_cover_after;
113 int number_of_covers;
116 static GObjectClass *backend_parent_class;
118 static void gtk_print_backend_cups_class_init (GtkPrintBackendCupsClass *class);
119 static void gtk_print_backend_cups_init (GtkPrintBackendCups *impl);
120 static void gtk_print_backend_cups_finalize (GObject *object);
121 static void gtk_print_backend_cups_dispose (GObject *object);
122 static void cups_get_printer_list (GtkPrintBackend *print_backend);
123 static void cups_request_execute (GtkPrintBackendCups *print_backend,
124 GtkCupsRequest *request,
125 GtkPrintCupsResponseCallbackFunc callback,
127 GDestroyNotify notify);
128 static void cups_printer_get_settings_from_options (GtkPrinter *printer,
129 GtkPrinterOptionSet *options,
130 GtkPrintSettings *settings);
131 static gboolean cups_printer_mark_conflicts (GtkPrinter *printer,
132 GtkPrinterOptionSet *options);
133 static GtkPrinterOptionSet *cups_printer_get_options (GtkPrinter *printer,
134 GtkPrintSettings *settings,
135 GtkPageSetup *page_setup,
136 GtkPrintCapabilities capabilities);
137 static void cups_printer_prepare_for_print (GtkPrinter *printer,
138 GtkPrintJob *print_job,
139 GtkPrintSettings *settings,
140 GtkPageSetup *page_setup);
141 static GList * cups_printer_list_papers (GtkPrinter *printer);
142 static GtkPageSetup * cups_printer_get_default_page_size (GtkPrinter *printer);
143 static void cups_printer_request_details (GtkPrinter *printer);
144 static void cups_request_default_printer (GtkPrintBackendCups *print_backend);
145 static void cups_request_ppd (GtkPrinter *printer);
146 static void cups_printer_get_hard_margins (GtkPrinter *printer,
151 static GtkPrintCapabilities cups_printer_get_capabilities (GtkPrinter *printer);
152 static void set_option_from_settings (GtkPrinterOption *option,
153 GtkPrintSettings *setting);
154 static void cups_begin_polling_info (GtkPrintBackendCups *print_backend,
157 static gboolean cups_job_info_poll_timeout (gpointer user_data);
158 static void gtk_print_backend_cups_print_stream (GtkPrintBackend *backend,
161 GtkPrintJobCompleteFunc callback,
163 GDestroyNotify dnotify);
164 static cairo_surface_t * cups_printer_create_cairo_surface (GtkPrinter *printer,
165 GtkPrintSettings *settings,
168 GIOChannel *cache_io);
172 gtk_print_backend_cups_register_type (GTypeModule *module)
174 static const GTypeInfo print_backend_cups_info =
176 sizeof (GtkPrintBackendCupsClass),
177 NULL, /* base_init */
178 NULL, /* base_finalize */
179 (GClassInitFunc) gtk_print_backend_cups_class_init,
180 NULL, /* class_finalize */
181 NULL, /* class_data */
182 sizeof (GtkPrintBackendCups),
184 (GInstanceInitFunc) gtk_print_backend_cups_init
187 print_backend_cups_type = g_type_module_register_type (module,
188 GTK_TYPE_PRINT_BACKEND,
189 "GtkPrintBackendCups",
190 &print_backend_cups_info, 0);
194 pb_module_init (GTypeModule *module)
197 g_print ("CUPS Backend: Initializing the CUPS print backend module\n"));
199 gtk_print_backend_cups_register_type (module);
200 gtk_printer_cups_register_type (module);
204 pb_module_exit (void)
209 G_MODULE_EXPORT GtkPrintBackend *
210 pb_module_create (void)
212 return gtk_print_backend_cups_new ();
216 * GtkPrintBackendCups
219 gtk_print_backend_cups_get_type (void)
221 return print_backend_cups_type;
225 * gtk_print_backend_cups_new:
227 * Creates a new #GtkPrintBackendCups object. #GtkPrintBackendCups
228 * implements the #GtkPrintBackend interface with direct access to
229 * the filesystem using Unix/Linux API calls
231 * Return value: the new #GtkPrintBackendCups object
234 gtk_print_backend_cups_new (void)
237 g_print ("CUPS Backend: Creating a new CUPS print backend object\n"));
239 return g_object_new (GTK_TYPE_PRINT_BACKEND_CUPS, NULL);
243 gtk_print_backend_cups_class_init (GtkPrintBackendCupsClass *class)
245 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
246 GtkPrintBackendClass *backend_class = GTK_PRINT_BACKEND_CLASS (class);
248 backend_parent_class = g_type_class_peek_parent (class);
250 gobject_class->finalize = gtk_print_backend_cups_finalize;
251 gobject_class->dispose = gtk_print_backend_cups_dispose;
253 backend_class->request_printer_list = cups_get_printer_list;
254 backend_class->print_stream = gtk_print_backend_cups_print_stream;
255 backend_class->printer_request_details = cups_printer_request_details;
256 backend_class->printer_create_cairo_surface = cups_printer_create_cairo_surface;
257 backend_class->printer_get_options = cups_printer_get_options;
258 backend_class->printer_mark_conflicts = cups_printer_mark_conflicts;
259 backend_class->printer_get_settings_from_options = cups_printer_get_settings_from_options;
260 backend_class->printer_prepare_for_print = cups_printer_prepare_for_print;
261 backend_class->printer_list_papers = cups_printer_list_papers;
262 backend_class->printer_get_default_page_size = cups_printer_get_default_page_size;
263 backend_class->printer_get_hard_margins = cups_printer_get_hard_margins;
264 backend_class->printer_get_capabilities = cups_printer_get_capabilities;
267 static cairo_status_t
268 _cairo_write_to_cups (void *closure,
269 const unsigned char *data,
272 GIOChannel *io = (GIOChannel *)closure;
279 g_print ("CUPS Backend: Writing %i byte chunk to temp file\n", length));
283 g_io_channel_write_chars (io, (gchar *)data, length, &written, &error);
288 g_print ("CUPS Backend: Error writing to temp file, %s\n",
291 g_error_free (error);
292 return CAIRO_STATUS_WRITE_ERROR;
296 g_print ("CUPS Backend: Wrote %i bytes to temp file\n", written));
302 return CAIRO_STATUS_SUCCESS;
305 static cairo_surface_t *
306 cups_printer_create_cairo_surface (GtkPrinter *printer,
307 GtkPrintSettings *settings,
310 GIOChannel *cache_io)
312 cairo_surface_t *surface;
313 ppd_file_t *ppd_file = NULL;
314 ppd_attr_t *ppd_attr = NULL;
317 /* TODO: check if it is a ps or pdf printer */
319 surface = cairo_ps_surface_create_for_stream (_cairo_write_to_cups, cache_io, width, height);
321 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
323 if (ppd_file != NULL)
325 ppd_attr = ppdFindAttr (ppd_file, "LanguageLevel", NULL);
327 if (ppd_attr != NULL)
328 level = atoi (ppd_attr->value);
332 cairo_ps_surface_restrict_to_level (surface, CAIRO_PS_LEVEL_2);
335 cairo_ps_surface_restrict_to_level (surface, CAIRO_PS_LEVEL_3);
337 /* TODO: DPI from settings object? */
338 cairo_surface_set_fallback_resolution (surface, 300, 300);
344 GtkPrintJobCompleteFunc callback;
347 GDestroyNotify dnotify;
348 } CupsPrintStreamData;
351 cups_free_print_stream_data (CupsPrintStreamData *data)
354 g_print ("CUPS Backend: %s\n", G_STRFUNC));
357 data->dnotify (data->user_data);
358 g_object_unref (data->job);
363 cups_print_cb (GtkPrintBackendCups *print_backend,
364 GtkCupsResult *result,
367 GError *error = NULL;
368 CupsPrintStreamData *ps = user_data;
370 GDK_THREADS_ENTER ();
373 g_print ("CUPS Backend: %s\n", G_STRFUNC));
375 if (gtk_cups_result_is_error (result))
376 error = g_error_new_literal (gtk_print_error_quark (),
377 GTK_PRINT_ERROR_INTERNAL_ERROR,
378 gtk_cups_result_get_error_string (result));
381 ps->callback (ps->job, ps->user_data, error);
386 ipp_attribute_t *attr; /* IPP job-id attribute */
387 ipp_t *response = gtk_cups_result_get_response (result);
389 if ((attr = ippFindAttribute (response, "job-id", IPP_TAG_INTEGER)) != NULL)
390 job_id = attr->values[0].integer;
392 if (!gtk_print_job_get_track_print_status (ps->job) || job_id == 0)
393 gtk_print_job_set_status (ps->job, GTK_PRINT_STATUS_FINISHED);
396 gtk_print_job_set_status (ps->job, GTK_PRINT_STATUS_PENDING);
397 cups_begin_polling_info (print_backend, ps->job, job_id);
401 gtk_print_job_set_status (ps->job, GTK_PRINT_STATUS_FINISHED_ABORTED);
405 g_error_free (error);
407 GDK_THREADS_LEAVE ();
411 add_cups_options (const gchar *key,
415 GtkCupsRequest *request = user_data;
417 if (!g_str_has_prefix (key, "cups-"))
420 if (strcmp (value, "gtk-ignore-value") == 0)
423 key = key + strlen ("cups-");
425 gtk_cups_request_encode_option (request, key, value);
429 gtk_print_backend_cups_print_stream (GtkPrintBackend *print_backend,
432 GtkPrintJobCompleteFunc callback,
434 GDestroyNotify dnotify)
436 GtkPrinterCups *cups_printer;
437 CupsPrintStreamData *ps;
438 GtkCupsRequest *request;
439 GtkPrintSettings *settings;
441 char printer_absolute_uri[HTTP_MAX_URI];
444 g_print ("CUPS Backend: %s\n", G_STRFUNC));
446 cups_printer = GTK_PRINTER_CUPS (gtk_print_job_get_printer (job));
447 settings = gtk_print_job_get_settings (job);
449 request = gtk_cups_request_new (NULL,
454 cups_printer->device_uri);
456 #if (CUPS_VERSION_MAJOR == 1 && CUPS_VERSION_MINOR >= 2) || CUPS_VERSION_MAJOR > 1
457 httpAssembleURIf (HTTP_URI_CODING_ALL,
458 printer_absolute_uri,
459 sizeof (printer_absolute_uri),
465 gtk_printer_get_name (gtk_print_job_get_printer (job)));
467 g_snprintf (printer_absolute_uri,
468 sizeof (printer_absolute_uri),
469 "ipp://localhost:%d/printers/%s",
471 gtk_printer_get_name (gtk_print_job_get_printer (job)));
474 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION,
475 IPP_TAG_URI, "printer-uri",
476 NULL, printer_absolute_uri);
478 title = gtk_print_job_get_title (job);
480 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION,
481 IPP_TAG_NAME, "job-name",
484 gtk_print_settings_foreach (settings, add_cups_options, request);
486 ps = g_new0 (CupsPrintStreamData, 1);
487 ps->callback = callback;
488 ps->user_data = user_data;
489 ps->dnotify = dnotify;
490 ps->job = g_object_ref (job);
492 cups_request_execute (GTK_PRINT_BACKEND_CUPS (print_backend),
494 (GtkPrintCupsResponseCallbackFunc) cups_print_cb,
496 (GDestroyNotify)cups_free_print_stream_data);
501 gtk_print_backend_cups_init (GtkPrintBackendCups *backend_cups)
503 backend_cups->list_printers_poll = FALSE;
504 backend_cups->got_default_printer = FALSE;
505 backend_cups->list_printers_pending = FALSE;
507 backend_cups->covers = NULL;
508 backend_cups->default_cover_before = NULL;
509 backend_cups->default_cover_after = NULL;
510 backend_cups->number_of_covers = 0;
512 cups_request_default_printer (backend_cups);
516 gtk_print_backend_cups_finalize (GObject *object)
518 GtkPrintBackendCups *backend_cups;
521 g_print ("CUPS Backend: finalizing CUPS backend module\n"));
523 backend_cups = GTK_PRINT_BACKEND_CUPS (object);
525 g_free (backend_cups->default_printer);
526 backend_cups->default_printer = NULL;
528 g_strfreev (backend_cups->covers);
529 backend_cups->number_of_covers = 0;
531 g_free (backend_cups->default_cover_before);
532 g_free (backend_cups->default_cover_after);
534 backend_parent_class->finalize (object);
538 gtk_print_backend_cups_dispose (GObject *object)
540 GtkPrintBackendCups *backend_cups;
543 g_print ("CUPS Backend: %s\n", G_STRFUNC));
545 backend_cups = GTK_PRINT_BACKEND_CUPS (object);
547 if (backend_cups->list_printers_poll > 0)
548 g_source_remove (backend_cups->list_printers_poll);
549 backend_cups->list_printers_poll = 0;
551 backend_parent_class->dispose (object);
556 cups_dispatch_watch_check (GSource *source)
558 GtkPrintCupsDispatchWatch *dispatch;
559 GtkCupsPollState poll_state;
563 g_print ("CUPS Backend: %s <source %p>\n", G_STRFUNC, source));
565 dispatch = (GtkPrintCupsDispatchWatch *) source;
567 poll_state = gtk_cups_request_get_poll_state (dispatch->request);
569 if (dispatch->request->http != NULL)
571 if (dispatch->data_poll == NULL)
573 dispatch->data_poll = g_new0 (GPollFD, 1);
574 g_source_add_poll (source, dispatch->data_poll);
578 if (poll_state == GTK_CUPS_HTTP_READ)
579 dispatch->data_poll->events = G_IO_IN | G_IO_HUP | G_IO_ERR | G_IO_PRI;
580 else if (poll_state == GTK_CUPS_HTTP_WRITE)
581 dispatch->data_poll->events = G_IO_OUT | G_IO_ERR;
583 dispatch->data_poll->events = 0;
586 #ifdef HAVE_CUPS_API_1_2
587 dispatch->data_poll->fd = httpGetFd (dispatch->request->http);
589 dispatch->data_poll->fd = dispatch->request->http->fd;
593 if (poll_state != GTK_CUPS_HTTP_IDLE)
594 if (!(dispatch->data_poll->revents & dispatch->data_poll->events))
597 result = gtk_cups_request_read_write (dispatch->request);
598 if (result && dispatch->data_poll != NULL)
600 g_source_remove_poll (source, dispatch->data_poll);
601 g_free (dispatch->data_poll);
602 dispatch->data_poll = NULL;
609 cups_dispatch_watch_prepare (GSource *source,
612 GtkPrintCupsDispatchWatch *dispatch;
614 dispatch = (GtkPrintCupsDispatchWatch *) source;
617 g_print ("CUPS Backend: %s <source %p>\n", G_STRFUNC, source));
621 return gtk_cups_request_read_write (dispatch->request);
625 cups_dispatch_watch_dispatch (GSource *source,
626 GSourceFunc callback,
629 GtkPrintCupsDispatchWatch *dispatch;
630 GtkPrintCupsResponseCallbackFunc ep_callback;
631 GtkCupsResult *result;
633 g_assert (callback != NULL);
635 ep_callback = (GtkPrintCupsResponseCallbackFunc) callback;
637 dispatch = (GtkPrintCupsDispatchWatch *) source;
639 result = gtk_cups_request_get_result (dispatch->request);
642 g_print ("CUPS Backend: %s <source %p>\n", G_STRFUNC, source));
644 if (gtk_cups_result_is_error (result))
647 g_print("Error result: %s (type %i, status %i, code %i)\n",
648 gtk_cups_result_get_error_string (result),
649 gtk_cups_result_get_error_type (result),
650 gtk_cups_result_get_error_status (result),
651 gtk_cups_result_get_error_code (result)));
654 ep_callback (GTK_PRINT_BACKEND (dispatch->backend), result, user_data);
660 cups_dispatch_watch_finalize (GSource *source)
662 GtkPrintCupsDispatchWatch *dispatch;
665 g_print ("CUPS Backend: %s <source %p>\n", G_STRFUNC, source));
667 dispatch = (GtkPrintCupsDispatchWatch *) source;
669 gtk_cups_request_free (dispatch->request);
671 if (dispatch->backend)
673 /* We need to unref this at idle time, because it might be the
674 * last reference to this module causing the code to be
675 * unloaded (including this particular function!)
676 * Update: Doing this at idle caused a deadlock taking the
677 * mainloop context lock while being in a GSource callout for
678 * multithreaded apps. So, for now we just disable unloading
679 * of print backends. See _gtk_print_backend_create for the
682 g_object_unref (dispatch->backend);
683 dispatch->backend = NULL;
686 g_free (dispatch->data_poll);
689 static GSourceFuncs _cups_dispatch_watch_funcs = {
690 cups_dispatch_watch_prepare,
691 cups_dispatch_watch_check,
692 cups_dispatch_watch_dispatch,
693 cups_dispatch_watch_finalize
698 cups_request_execute (GtkPrintBackendCups *print_backend,
699 GtkCupsRequest *request,
700 GtkPrintCupsResponseCallbackFunc callback,
702 GDestroyNotify notify)
704 GtkPrintCupsDispatchWatch *dispatch;
706 dispatch = (GtkPrintCupsDispatchWatch *) g_source_new (&_cups_dispatch_watch_funcs,
707 sizeof (GtkPrintCupsDispatchWatch));
710 g_print ("CUPS Backend: %s <source %p> - Executing cups request on server '%s' and resource '%s'\n", G_STRFUNC, dispatch, request->server, request->resource));
712 dispatch->request = request;
713 dispatch->backend = g_object_ref (print_backend);
714 dispatch->data_poll = NULL;
716 g_source_set_callback ((GSource *) dispatch, (GSourceFunc) callback, user_data, notify);
718 g_source_attach ((GSource *) dispatch, NULL);
719 g_source_unref ((GSource *) dispatch);
724 cups_request_printer_info_cb (GtkPrintBackendCups *backend,
725 GtkCupsResult *result,
728 ipp_attribute_t *attr;
731 GtkPrinterCups *cups_printer;
737 gboolean status_changed;
739 g_assert (GTK_IS_PRINT_BACKEND_CUPS (backend));
741 printer_name = (gchar *)user_data;
742 printer = gtk_print_backend_find_printer (GTK_PRINT_BACKEND (backend),
746 g_print ("CUPS Backend: %s - Got printer info for printer '%s'\n", G_STRFUNC, printer_name));
751 g_print ("CUPS Backend: Could not find printer called '%s'\n", printer_name));
755 cups_printer = GTK_PRINTER_CUPS (printer);
757 if (gtk_cups_result_is_error (result))
759 if (gtk_printer_is_new (printer))
761 gtk_print_backend_remove_printer (GTK_PRINT_BACKEND (backend),
766 return; /* TODO: mark as inactive printer */
769 response = gtk_cups_result_get_response (result);
771 /* TODO: determine printer type and use correct icon */
772 gtk_printer_set_icon_name (printer, "gtk-print");
778 for (attr = response->attrs; attr != NULL; attr = attr->next)
783 _CUPS_MAP_ATTR_STR (attr, loc, "printer-location");
784 _CUPS_MAP_ATTR_STR (attr, desc, "printer-info");
785 _CUPS_MAP_ATTR_STR (attr, state_msg, "printer-state-message");
786 _CUPS_MAP_ATTR_INT (attr, cups_printer->state, "printer-state");
787 _CUPS_MAP_ATTR_INT (attr, job_count, "queued-job-count");
790 status_changed = gtk_printer_set_job_count (printer, job_count);
792 status_changed |= gtk_printer_set_location (printer, loc);
793 status_changed |= gtk_printer_set_description (printer, desc);
794 status_changed |= gtk_printer_set_state_message (printer, state_msg);
797 g_signal_emit_by_name (GTK_PRINT_BACKEND (backend),
798 "printer-status-changed", printer);
802 cups_request_printer_info (GtkPrintBackendCups *print_backend,
803 const gchar *printer_name)
805 GtkCupsRequest *request;
807 static const char * const pattrs[] = /* Attributes we're interested in */
811 "printer-state-message",
814 "job-sheets-supported",
818 request = gtk_cups_request_new (NULL,
820 IPP_GET_PRINTER_ATTRIBUTES,
825 printer_uri = g_strdup_printf ("ipp://localhost/printers/%s",
827 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION, IPP_TAG_URI,
828 "printer-uri", NULL, printer_uri);
831 g_print ("CUPS Backend: %s - Requesting printer info for URI '%s'\n", G_STRFUNC, printer_uri));
833 g_free (printer_uri);
835 gtk_cups_request_ipp_add_strings (request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
836 "requested-attributes", G_N_ELEMENTS (pattrs),
839 cups_request_execute (print_backend,
841 (GtkPrintCupsResponseCallbackFunc) cups_request_printer_info_cb,
842 g_strdup (printer_name),
843 (GDestroyNotify) g_free);
848 GtkPrintBackendCups *print_backend;
855 job_object_died (gpointer user_data,
856 GObject *where_the_object_was)
858 CupsJobPollData *data = user_data;
863 cups_job_poll_data_free (CupsJobPollData *data)
866 g_object_weak_unref (G_OBJECT (data->job), job_object_died, data);
872 cups_request_job_info_cb (GtkPrintBackendCups *print_backend,
873 GtkCupsResult *result,
876 CupsJobPollData *data = user_data;
877 ipp_attribute_t *attr;
882 GDK_THREADS_ENTER ();
884 if (data->job == NULL)
886 cups_job_poll_data_free (data);
892 response = gtk_cups_result_get_response (result);
895 for (attr = response->attrs; attr != NULL; attr = attr->next)
900 _CUPS_MAP_ATTR_INT (attr, state, "job-state");
906 case IPP_JOB_PENDING:
908 case IPP_JOB_STOPPED:
909 gtk_print_job_set_status (data->job,
910 GTK_PRINT_STATUS_PENDING);
912 case IPP_JOB_PROCESSING:
913 gtk_print_job_set_status (data->job,
914 GTK_PRINT_STATUS_PRINTING);
917 case IPP_JOB_CANCELLED:
918 case IPP_JOB_ABORTED:
919 gtk_print_job_set_status (data->job,
920 GTK_PRINT_STATUS_FINISHED_ABORTED);
924 case IPP_JOB_COMPLETED:
925 gtk_print_job_set_status (data->job,
926 GTK_PRINT_STATUS_FINISHED);
931 if (!done && data->job != NULL)
935 if (data->counter < 5)
937 else if (data->counter < 10)
942 g_timeout_add (timeout, cups_job_info_poll_timeout, data);
945 cups_job_poll_data_free (data);
948 GDK_THREADS_LEAVE ();
952 cups_request_job_info (CupsJobPollData *data)
954 GtkCupsRequest *request;
957 request = gtk_cups_request_new (NULL,
959 IPP_GET_JOB_ATTRIBUTES,
964 job_uri = g_strdup_printf ("ipp://localhost/jobs/%d", data->job_id);
965 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION, IPP_TAG_URI,
966 "job-uri", NULL, job_uri);
969 cups_request_execute (data->print_backend,
971 (GtkPrintCupsResponseCallbackFunc) cups_request_job_info_cb,
977 cups_job_info_poll_timeout (gpointer user_data)
979 CupsJobPollData *data = user_data;
981 if (data->job == NULL)
982 cups_job_poll_data_free (data);
984 cups_request_job_info (data);
990 cups_begin_polling_info (GtkPrintBackendCups *print_backend,
994 CupsJobPollData *data;
996 data = g_new0 (CupsJobPollData, 1);
998 data->print_backend = print_backend;
1000 data->job_id = job_id;
1003 g_object_weak_ref (G_OBJECT (job), job_object_died, data);
1005 cups_request_job_info (data);
1009 mark_printer_inactive (GtkPrinter *printer,
1010 GtkPrintBackend *backend)
1012 gtk_printer_set_is_active (printer, FALSE);
1013 g_signal_emit_by_name (backend, "printer-removed", printer);
1017 find_printer (GtkPrinter *printer,
1018 const gchar *find_name)
1020 const gchar *printer_name;
1022 printer_name = gtk_printer_get_name (printer);
1023 return g_ascii_strcasecmp (printer_name, find_name);
1027 cups_request_printer_list_cb (GtkPrintBackendCups *cups_backend,
1028 GtkCupsResult *result,
1031 GtkPrintBackend *backend = GTK_PRINT_BACKEND (cups_backend);
1032 ipp_attribute_t *attr;
1034 gboolean list_has_changed;
1035 GList *removed_printer_checklist;
1037 GDK_THREADS_ENTER ();
1039 list_has_changed = FALSE;
1042 g_print ("CUPS Backend: %s\n", G_STRFUNC));
1044 cups_backend->list_printers_pending = FALSE;
1046 if (gtk_cups_result_is_error (result))
1049 g_warning ("CUPS Backend: Error getting printer list: %s",
1050 gtk_cups_result_get_error_string (result)));
1055 /* Gather the names of the printers in the current queue
1056 * so we may check to see if they were removed
1058 removed_printer_checklist = gtk_print_backend_get_printer_list (backend);
1060 response = gtk_cups_result_get_response (result);
1062 for (attr = response->attrs; attr != NULL; attr = attr->next)
1064 GtkPrinter *printer;
1065 const gchar *printer_name = NULL;
1066 const gchar *printer_uri = NULL;
1067 const gchar *member_uris = NULL;
1068 const gchar *location = NULL;
1069 const gchar *description = NULL;
1070 const gchar *state_msg = NULL;
1073 gboolean status_changed = FALSE;
1076 const gchar *reason_msg = NULL;
1077 gchar *reason_msg_desc = NULL;
1078 gchar *tmp_msg = NULL;
1079 gchar *tmp_msg2 = NULL;
1080 gint printer_state_reason_level = 0; /* 0 - none, 1 - report, 2 - warning, 3 - error */
1081 gboolean interested_in = FALSE;
1082 gboolean found = FALSE;
1083 static const char * const reasons[] = /* Reasons we're interested in */
1089 "marker-supply-low",
1090 "marker-supply-empty",
1096 "connecting-to-device",
1099 static const char * reasons_descs[] =
1101 N_("Printer '%s' is low on toner."),
1102 N_("Printer '%s' has no toner left."),
1103 /* Translators: "Developer" like on photo development context */
1104 N_("Printer '%s' is low on developer."),
1105 /* Translators: "Developer" like on photo development context */
1106 N_("Printer '%s' is out of developer."),
1107 /* Translators: "marker" is one color bin of the printer */
1108 N_("Printer '%s' is low on at least one marker supply."),
1109 /* Translators: "marker" is one color bin of the printer */
1110 N_("Printer '%s' is out of at least one marker supply."),
1111 N_("The cover is open on printer '%s'."),
1112 N_("The door is open on printer '%s'."),
1113 N_("Printer '%s' is low on paper."),
1114 N_("Printer '%s' is out of paper."),
1115 N_("Printer '%s' is currently off-line."),
1116 N_("Printer '%s' may not be connected."),
1117 N_("There is a problem on printer '%s'.")
1119 gboolean is_paused = FALSE;
1120 gboolean is_accepting_jobs = TRUE;
1122 /* Skip leading attributes until we hit a printer...
1124 while (attr != NULL && attr->group_tag != IPP_TAG_PRINTER)
1130 while (attr != NULL && attr->group_tag == IPP_TAG_PRINTER)
1132 if (strcmp (attr->name, "printer-name") == 0 &&
1133 attr->value_tag == IPP_TAG_NAME)
1134 printer_name = attr->values[0].string.text;
1135 else if (strcmp (attr->name, "printer-uri-supported") == 0 &&
1136 attr->value_tag == IPP_TAG_URI)
1137 printer_uri = attr->values[0].string.text;
1138 else if (strcmp (attr->name, "member-uris") == 0 &&
1139 attr->value_tag == IPP_TAG_URI)
1140 member_uris = attr->values[0].string.text;
1141 else if (strcmp (attr->name, "printer-location") == 0)
1142 location = attr->values[0].string.text;
1143 else if (strcmp (attr->name, "printer-info") == 0)
1144 description = attr->values[0].string.text;
1145 else if (strcmp (attr->name, "printer-state-message") == 0)
1146 state_msg = attr->values[0].string.text;
1147 else if (strcmp (attr->name, "printer-state-reasons") == 0)
1148 /* Store most important reason to reason_msg and set
1149 its importance at printer_state_reason_level */
1151 for (i = 0; i < attr->num_values; i++)
1153 if (strcmp (attr->values[i].string.text, "none") != 0)
1155 /* Sets is_paused flag for paused printer. */
1156 if (strcmp (attr->values[i].string.text, "paused") == 0)
1161 interested_in = FALSE;
1162 for (j = 0; j < G_N_ELEMENTS (reasons); j++)
1163 if (strncmp (attr->values[i].string.text, reasons[j], strlen (reasons[j])) == 0)
1165 interested_in = TRUE;
1171 if (g_str_has_suffix (attr->values[i].string.text, "-report"))
1173 if (printer_state_reason_level <= 1)
1175 reason_msg = attr->values[i].string.text;
1176 printer_state_reason_level = 1;
1179 else if (g_str_has_suffix (attr->values[i].string.text, "-warning"))
1181 if (printer_state_reason_level <= 2)
1183 reason_msg = attr->values[i].string.text;
1184 printer_state_reason_level = 2;
1187 else /* It is error in the case of no suffix. */
1189 reason_msg = attr->values[i].string.text;
1190 printer_state_reason_level = 3;
1196 else if (strcmp (attr->name, "printer-state") == 0)
1197 state = attr->values[0].integer;
1198 else if (strcmp (attr->name, "queued-job-count") == 0)
1199 job_count = attr->values[0].integer;
1200 else if (strcmp (attr->name, "printer-is-accepting-jobs") == 0)
1202 if (attr->values[0].boolean == 1)
1203 is_accepting_jobs = TRUE;
1205 is_accepting_jobs = FALSE;
1207 else if (strcmp (attr->name, "job-sheets-supported") == 0)
1209 if (cups_backend->covers == NULL)
1211 cups_backend->number_of_covers = attr->num_values;
1212 cups_backend->covers = g_new (char *, cups_backend->number_of_covers + 1);
1214 for (i = 0; i < cups_backend->number_of_covers; i++)
1215 cups_backend->covers[i] = g_strdup (attr->values[i].string.text);
1217 cups_backend->covers[cups_backend->number_of_covers] = NULL;
1220 else if (strcmp (attr->name, "job-sheets-default") == 0)
1222 if ( (cups_backend->default_cover_before == NULL) && (cups_backend->default_cover_after == NULL))
1224 if (attr->num_values == 2)
1226 cups_backend->default_cover_before = g_strdup (attr->values[0].string.text);
1227 cups_backend->default_cover_after = g_strdup (attr->values[1].string.text);
1234 g_print ("CUPS Backend: Attribute %s ignored", attr->name));
1240 if (printer_name == NULL ||
1241 (printer_uri == NULL && member_uris == NULL))
1249 /* remove name from checklist if it was found */
1250 node = g_list_find_custom (removed_printer_checklist, printer_name, (GCompareFunc) find_printer);
1251 removed_printer_checklist = g_list_delete_link (removed_printer_checklist, node);
1253 printer = gtk_print_backend_find_printer (backend, printer_name);
1256 GtkPrinterCups *cups_printer;
1257 char uri[HTTP_MAX_URI]; /* Printer URI */
1258 char method[HTTP_MAX_URI]; /* Method/scheme name */
1259 char username[HTTP_MAX_URI]; /* Username:password */
1260 char hostname[HTTP_MAX_URI]; /* Hostname */
1261 char resource[HTTP_MAX_URI]; /* Resource name */
1262 int port; /* Port number */
1264 list_has_changed = TRUE;
1265 cups_printer = gtk_printer_cups_new (printer_name, backend);
1267 cups_printer->device_uri = g_strdup_printf ("/printers/%s", printer_name);
1269 /* Check to see if we are looking at a class */
1272 cups_printer->printer_uri = g_strdup (member_uris);
1273 /* TODO if member_uris is a class we need to recursivly find a printer */
1275 g_print ("CUPS Backend: Found class with printer %s\n", member_uris));
1279 cups_printer->printer_uri = g_strdup (printer_uri);
1281 g_print ("CUPS Backend: Found printer %s\n", printer_uri));
1284 #if (CUPS_VERSION_MAJOR == 1 && CUPS_VERSION_MINOR >= 2) || CUPS_VERSION_MAJOR > 1
1285 httpSeparateURI (HTTP_URI_CODING_ALL, cups_printer->printer_uri,
1286 method, sizeof (method),
1287 username, sizeof (username),
1288 hostname, sizeof (hostname),
1290 resource, sizeof (resource));
1293 httpSeparate (cups_printer->printer_uri,
1301 if (strncmp (resource, "/printers/", 10) == 0)
1303 cups_printer->ppd_name = g_strdup (resource + 10);
1305 g_print ("CUPS Backend: Setting ppd name '%s' for printer/class '%s'\n", cups_printer->ppd_name, printer_name));
1308 gethostname (uri, sizeof (uri));
1309 if (strcasecmp (uri, hostname) == 0)
1310 strcpy (hostname, "localhost");
1312 cups_printer->hostname = g_strdup (hostname);
1313 cups_printer->port = port;
1315 printer = GTK_PRINTER (cups_printer);
1317 if (cups_backend->default_printer != NULL &&
1318 strcmp (cups_backend->default_printer, gtk_printer_get_name (printer)) == 0)
1319 gtk_printer_set_is_default (printer, TRUE);
1322 gtk_print_backend_add_printer (backend, printer);
1325 g_object_ref (printer);
1327 gtk_printer_set_is_paused (printer, is_paused);
1328 gtk_printer_set_is_accepting_jobs (printer, is_accepting_jobs);
1330 if (!gtk_printer_is_active (printer))
1332 gtk_printer_set_is_active (printer, TRUE);
1333 gtk_printer_set_is_new (printer, TRUE);
1334 list_has_changed = TRUE;
1337 if (gtk_printer_is_new (printer))
1339 g_signal_emit_by_name (backend, "printer-added", printer);
1341 gtk_printer_set_is_new (printer, FALSE);
1345 /* Getting printer info with separate requests overwhelms cups
1346 * when the printer list has more than a handful of printers.
1348 cups_request_printer_info (cups_backend, gtk_printer_get_name (printer));
1351 GTK_PRINTER_CUPS (printer)->state = state;
1352 status_changed = gtk_printer_set_job_count (printer, job_count);
1353 status_changed |= gtk_printer_set_location (printer, location);
1354 status_changed |= gtk_printer_set_description (printer, description);
1356 if (state_msg != NULL && strlen (state_msg) == 0)
1358 if (is_paused && !is_accepting_jobs)
1359 tmp_msg2 = g_strdup ( N_("Paused ; Rejecting Jobs"));
1360 if (is_paused && is_accepting_jobs)
1361 tmp_msg2 = g_strdup ( N_("Paused"));
1362 if (!is_paused && !is_accepting_jobs)
1363 tmp_msg2 = g_strdup ( N_("Rejecting Jobs"));
1365 if (tmp_msg2 != NULL)
1366 state_msg = tmp_msg2;
1369 /* Set description of the reason and combine it with printer-state-message. */
1370 if ( (reason_msg != NULL))
1372 for (i = 0; i < G_N_ELEMENTS (reasons); i++)
1374 if (strncmp (reason_msg, reasons[i], strlen (reasons[i])) == 0)
1376 reason_msg_desc = g_strdup_printf (reasons_descs[i], printer_name);
1383 printer_state_reason_level = 0;
1385 if (printer_state_reason_level >= 2)
1387 if (strlen (state_msg) == 0)
1388 state_msg = reason_msg_desc;
1391 tmp_msg = g_strjoin (" ; ", state_msg, reason_msg_desc, NULL);
1392 state_msg = tmp_msg;
1397 status_changed |= gtk_printer_set_state_message (printer, state_msg);
1398 status_changed |= gtk_printer_set_is_accepting_jobs (printer, is_accepting_jobs);
1400 if (tmp_msg != NULL)
1403 if (tmp_msg2 != NULL)
1406 if (reason_msg_desc != NULL)
1407 g_free (reason_msg_desc);
1409 /* Set printer icon according to importance
1410 (none, report, warning, error - report is omitted). */
1411 if (printer_state_reason_level == 3)
1412 gtk_printer_set_icon_name (printer, "gtk-print-error");
1413 else if (printer_state_reason_level == 2)
1414 gtk_printer_set_icon_name (printer, "gtk-print-warning");
1415 else if (gtk_printer_is_paused (printer))
1416 gtk_printer_set_icon_name (printer, "gtk-print-paused");
1418 gtk_printer_set_icon_name (printer, "gtk-print");
1421 g_signal_emit_by_name (GTK_PRINT_BACKEND (backend),
1422 "printer-status-changed", printer);
1424 /* The ref is held by GtkPrintBackend, in add_printer() */
1425 g_object_unref (printer);
1431 /* look at the removed printers checklist and mark any printer
1432 as inactive if it is in the list, emitting a printer_removed signal */
1433 if (removed_printer_checklist != NULL)
1435 g_list_foreach (removed_printer_checklist, (GFunc) mark_printer_inactive, backend);
1436 g_list_free (removed_printer_checklist);
1437 list_has_changed = TRUE;
1441 if (list_has_changed)
1442 g_signal_emit_by_name (backend, "printer-list-changed");
1444 gtk_print_backend_set_list_done (backend);
1446 GDK_THREADS_LEAVE ();
1450 cups_request_printer_list (GtkPrintBackendCups *cups_backend)
1452 GtkCupsRequest *request;
1453 static const char * const pattrs[] = /* Attributes we're interested in */
1456 "printer-uri-supported",
1460 "printer-state-message",
1461 "printer-state-reasons",
1464 "printer-is-accepting-jobs",
1465 "job-sheets-supported",
1466 "job-sheets-default"
1469 if (cups_backend->list_printers_pending ||
1470 !cups_backend->got_default_printer)
1473 cups_backend->list_printers_pending = TRUE;
1475 request = gtk_cups_request_new (NULL,
1482 gtk_cups_request_ipp_add_strings (request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
1483 "requested-attributes", G_N_ELEMENTS (pattrs),
1486 cups_request_execute (cups_backend,
1488 (GtkPrintCupsResponseCallbackFunc) cups_request_printer_list_cb,
1496 cups_get_printer_list (GtkPrintBackend *backend)
1498 GtkPrintBackendCups *cups_backend;
1500 cups_backend = GTK_PRINT_BACKEND_CUPS (backend);
1501 if (cups_backend->list_printers_poll == 0)
1503 cups_request_printer_list (cups_backend);
1504 cups_backend->list_printers_poll = gdk_threads_add_timeout (3000,
1505 (GSourceFunc) cups_request_printer_list,
1511 GtkPrinterCups *printer;
1517 get_ppd_data_free (GetPPDData *data)
1520 g_print ("CUPS Backend: %s\n", G_STRFUNC));
1521 httpClose (data->http);
1522 g_io_channel_unref (data->ppd_io);
1523 g_object_unref (data->printer);
1528 cups_request_ppd_cb (GtkPrintBackendCups *print_backend,
1529 GtkCupsResult *result,
1533 GtkPrinter *printer;
1535 GDK_THREADS_ENTER ();
1538 g_print ("CUPS Backend: %s\n", G_STRFUNC));
1540 printer = GTK_PRINTER (data->printer);
1541 GTK_PRINTER_CUPS (printer)->reading_ppd = FALSE;
1543 if (gtk_cups_result_is_error (result))
1545 gboolean success = FALSE;
1547 /* if we get a 404 then it is just a raw printer without a ppd
1549 if ((gtk_cups_result_get_error_type (result) == GTK_CUPS_ERROR_HTTP) &&
1550 (gtk_cups_result_get_error_status (result) == HTTP_NOT_FOUND))
1552 gtk_printer_set_has_details (printer, TRUE);
1556 g_signal_emit_by_name (printer, "details-acquired", success);
1560 response = gtk_cups_result_get_response (result);
1562 /* let ppdOpenFd take over the ownership of the open file */
1563 g_io_channel_seek_position (data->ppd_io, 0, G_SEEK_SET, NULL);
1564 data->printer->ppd_file = ppdOpenFd (dup (g_io_channel_unix_get_fd (data->ppd_io)));
1566 ppdMarkDefaults (data->printer->ppd_file);
1568 gtk_printer_set_has_details (printer, TRUE);
1569 g_signal_emit_by_name (printer, "details-acquired", TRUE);
1572 GDK_THREADS_LEAVE ();
1576 cups_request_ppd (GtkPrinter *printer)
1579 GtkPrintBackend *print_backend;
1580 GtkPrinterCups *cups_printer;
1581 GtkCupsRequest *request;
1588 cups_printer = GTK_PRINTER_CUPS (printer);
1593 g_print ("CUPS Backend: %s\n", G_STRFUNC));
1595 http = httpConnectEncrypt (cups_printer->hostname,
1599 data = g_new0 (GetPPDData, 1);
1601 fd = g_file_open_tmp ("gtkprint_ppd_XXXXXX",
1605 #ifdef G_ENABLE_DEBUG
1606 /* If we are debugging printing don't delete the tmp files */
1607 if (!(gtk_debug_flags & GTK_DEBUG_PRINTING))
1608 unlink (ppd_filename);
1610 unlink (ppd_filename);
1611 #endif /* G_ENABLE_DEBUG */
1616 g_warning ("CUPS Backend: Failed to create temp file, %s\n",
1618 g_error_free (error);
1620 g_free (ppd_filename);
1623 g_signal_emit_by_name (printer, "details-acquired", FALSE);
1628 fchmod (fd, S_IRUSR | S_IWUSR);
1629 data->ppd_io = g_io_channel_unix_new (fd);
1630 g_io_channel_set_encoding (data->ppd_io, NULL, NULL);
1631 g_io_channel_set_close_on_unref (data->ppd_io, TRUE);
1633 data->printer = g_object_ref (printer);
1635 resource = g_strdup_printf ("/printers/%s.ppd",
1636 gtk_printer_cups_get_ppd_name (GTK_PRINTER_CUPS (printer)));
1638 request = gtk_cups_request_new (data->http,
1642 cups_printer->hostname,
1646 g_print ("CUPS Backend: Requesting resource %s to be written to temp file %s\n", resource, ppd_filename));
1649 g_free (ppd_filename);
1651 cups_printer->reading_ppd = TRUE;
1653 print_backend = gtk_printer_get_backend (printer);
1655 cups_request_execute (GTK_PRINT_BACKEND_CUPS (print_backend),
1657 (GtkPrintCupsResponseCallbackFunc) cups_request_ppd_cb,
1659 (GDestroyNotify)get_ppd_data_free);
1662 /* Ordering matters for default preference */
1663 static const char *lpoptions_locations[] = {
1664 "/etc/cups/lpoptions",
1670 cups_parse_user_default_printer (const char *filename,
1671 char **printer_name)
1674 char line[1024], *lineptr, *defname = NULL;
1676 if ((fp = g_fopen (filename, "r")) == NULL)
1679 while (fgets (line, sizeof (line), fp) != NULL)
1681 if (strncasecmp (line, "default", 7) != 0 || !isspace (line[7]))
1685 while (isspace (*lineptr))
1692 while (!isspace (*lineptr) && *lineptr && *lineptr != '/')
1697 if (*printer_name != NULL)
1698 g_free (*printer_name);
1700 *printer_name = g_strdup (defname);
1707 cups_get_user_default_printer (char **printer_name)
1711 for (i = 0; i < G_N_ELEMENTS (lpoptions_locations); i++)
1713 if (g_path_is_absolute (lpoptions_locations[i]))
1715 cups_parse_user_default_printer (lpoptions_locations[i],
1722 filename = g_build_filename (g_get_home_dir (),
1723 lpoptions_locations[i], NULL);
1724 cups_parse_user_default_printer (filename, printer_name);
1731 cups_parse_user_options (const char *filename,
1732 const char *printer_name,
1734 cups_option_t **options)
1737 gchar line[1024], *lineptr, *name;
1739 if ((fp = g_fopen (filename, "r")) == NULL)
1742 while (fgets (line, sizeof (line), fp) != NULL)
1744 if (strncasecmp (line, "dest", 4) == 0 && isspace (line[4]))
1746 else if (strncasecmp (line, "default", 7) == 0 && isspace (line[7]))
1751 /* Skip leading whitespace */
1752 while (isspace (*lineptr))
1758 /* NUL-terminate the name, stripping the instance name */
1760 while (!isspace (*lineptr) && *lineptr)
1762 if (*lineptr == '/')
1772 if (strncasecmp (name, printer_name, strlen (printer_name)) != 0)
1775 /* We found our printer, parse the options */
1776 num_options = cupsParseOptions (lineptr, num_options, options);
1785 cups_get_user_options (const char *printer_name,
1787 cups_option_t **options)
1791 for (i = 0; i < G_N_ELEMENTS (lpoptions_locations); i++)
1793 if (g_path_is_absolute (lpoptions_locations[i]))
1795 num_options = cups_parse_user_options (lpoptions_locations[i],
1804 filename = g_build_filename (g_get_home_dir (),
1805 lpoptions_locations[i], NULL);
1806 num_options = cups_parse_user_options (filename, printer_name,
1807 num_options, options);
1816 cups_request_default_printer_cb (GtkPrintBackendCups *print_backend,
1817 GtkCupsResult *result,
1821 ipp_attribute_t *attr;
1823 response = gtk_cups_result_get_response (result);
1825 if ((attr = ippFindAttribute (response, "printer-name", IPP_TAG_NAME)) != NULL)
1826 print_backend->default_printer = g_strdup (attr->values[0].string.text);
1828 print_backend->got_default_printer = TRUE;
1830 /* Make sure to kick off get_printers if we are polling it,
1831 * as we could have blocked this reading the default printer
1833 if (print_backend->list_printers_poll != 0)
1834 cups_request_printer_list (print_backend);
1838 cups_request_default_printer (GtkPrintBackendCups *print_backend)
1840 GtkCupsRequest *request;
1844 if ((str = g_getenv ("LPDEST")) != NULL)
1846 print_backend->default_printer = g_strdup (str);
1847 print_backend->got_default_printer = TRUE;
1850 else if ((str = g_getenv ("PRINTER")) != NULL &&
1851 strcmp (str, "lp") != 0)
1853 print_backend->default_printer = g_strdup (str);
1854 print_backend->got_default_printer = TRUE;
1858 /* Figure out user setting for default printer */
1859 cups_get_user_default_printer (&name);
1862 print_backend->default_printer = name;
1863 print_backend->got_default_printer = TRUE;
1867 request = gtk_cups_request_new (NULL,
1874 cups_request_execute (print_backend,
1876 (GtkPrintCupsResponseCallbackFunc) cups_request_default_printer_cb,
1877 g_object_ref (print_backend),
1882 cups_printer_request_details (GtkPrinter *printer)
1884 GtkPrinterCups *cups_printer;
1886 cups_printer = GTK_PRINTER_CUPS (printer);
1887 if (!cups_printer->reading_ppd &&
1888 gtk_printer_cups_get_ppd (cups_printer) == NULL)
1889 cups_request_ppd (printer);
1893 ppd_text_to_utf8 (ppd_file_t *ppd_file,
1896 const char *encoding = NULL;
1899 if (g_ascii_strcasecmp (ppd_file->lang_encoding, "UTF-8") == 0)
1901 return g_strdup (text);
1903 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "ISOLatin1") == 0)
1905 encoding = "ISO-8859-1";
1907 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "ISOLatin2") == 0)
1909 encoding = "ISO-8859-2";
1911 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "ISOLatin5") == 0)
1913 encoding = "ISO-8859-5";
1915 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "JIS83-RKSJ") == 0)
1917 encoding = "SHIFT-JIS";
1919 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "MacStandard") == 0)
1921 encoding = "MACINTOSH";
1923 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "WindowsANSI") == 0)
1925 encoding = "WINDOWS-1252";
1929 /* Fallback, try iso-8859-1... */
1930 encoding = "ISO-8859-1";
1933 res = g_convert (text, -1, "UTF-8", encoding, NULL, NULL, NULL);
1938 g_warning ("CUPS Backend: Unable to convert PPD text\n"));
1939 res = g_strdup ("???");
1945 /* TODO: Add more translations for common settings here */
1947 static const struct {
1948 const char *keyword;
1949 const char *translation;
1950 } cups_option_translations[] = {
1951 { "Duplex", N_("Two Sided") },
1952 { "MediaType", N_("Paper Type") },
1953 { "InputSlot", N_("Paper Source") },
1954 { "OutputBin", N_("Output Tray") },
1958 static const struct {
1959 const char *keyword;
1961 const char *translation;
1962 } cups_choice_translations[] = {
1963 { "Duplex", "None", N_("One Sided") },
1964 { "InputSlot", "Auto", N_("Auto Select") },
1965 { "InputSlot", "AutoSelect", N_("Auto Select") },
1966 { "InputSlot", "Default", N_("Printer Default") },
1967 { "InputSlot", "None", N_("Printer Default") },
1968 { "InputSlot", "PrinterDefault", N_("Printer Default") },
1969 { "InputSlot", "Unspecified", N_("Auto Select") },
1972 static const struct {
1973 const char *ppd_keyword;
1975 } option_names[] = {
1976 {"Duplex", "gtk-duplex" },
1977 {"MediaType", "gtk-paper-type"},
1978 {"InputSlot", "gtk-paper-source"},
1979 {"OutputBin", "gtk-output-tray"},
1982 /* keep sorted when changing */
1983 static const char *color_option_whitelist[] = {
1984 "BRColorEnhancement",
1990 "BlackSubstitution",
1998 "RPSBlackOverPrint",
2002 /* keep sorted when changing */
2003 static const char *color_group_whitelist[] = {
2010 "HPColorOptionsPanel",
2013 /* keep sorted when changing */
2014 static const char *image_quality_option_whitelist[] = {
2016 "BRHalfTonePattern",
2026 "HPGraphicsHalftone",
2041 /* keep sorted when changing */
2042 static const char *image_quality_group_whitelist[] = {
2049 /* keep sorted when changing */
2050 static const char * finishing_option_whitelist[] = {
2063 "StapleOrientation",
2069 /* keep sorted when changing */
2070 static const char *finishing_group_whitelist[] = {
2079 /* keep sorted when changing */
2080 static const char *cups_option_blacklist[] = {
2089 get_option_text (ppd_file_t *ppd_file,
2090 ppd_option_t *option)
2095 for (i = 0; i < G_N_ELEMENTS (cups_option_translations); i++)
2097 if (strcmp (cups_option_translations[i].keyword, option->keyword) == 0)
2098 return g_strdup (_(cups_option_translations[i].translation));
2101 utf8 = ppd_text_to_utf8 (ppd_file, option->text);
2103 /* Some ppd files have spaces in the text before the colon */
2110 get_choice_text (ppd_file_t *ppd_file,
2111 ppd_choice_t *choice)
2114 ppd_option_t *option = choice->option;
2115 const char *keyword = option->keyword;
2117 for (i = 0; i < G_N_ELEMENTS (cups_choice_translations); i++)
2119 if (strcmp (cups_choice_translations[i].keyword, keyword) == 0 &&
2120 strcmp (cups_choice_translations[i].choice, choice->choice) == 0)
2121 return g_strdup (_(cups_choice_translations[i].translation));
2123 return ppd_text_to_utf8 (ppd_file, choice->text);
2127 group_has_option (ppd_group_t *group,
2128 ppd_option_t *option)
2135 if (group->num_options > 0 &&
2136 option >= group->options && option < group->options + group->num_options)
2139 for (i = 0; i < group->num_subgroups; i++)
2141 if (group_has_option (&group->subgroups[i],option))
2148 set_option_off (GtkPrinterOption *option)
2150 /* Any of these will do, _set only applies the value
2151 * if its allowed of the option */
2152 gtk_printer_option_set (option, "False");
2153 gtk_printer_option_set (option, "Off");
2154 gtk_printer_option_set (option, "None");
2158 value_is_off (const char *value)
2160 return (strcasecmp (value, "None") == 0 ||
2161 strcasecmp (value, "Off") == 0 ||
2162 strcasecmp (value, "False") == 0);
2166 ppd_group_name (ppd_group_t *group)
2168 #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)
2176 available_choices (ppd_file_t *ppd,
2177 ppd_option_t *option,
2178 ppd_choice_t ***available,
2179 gboolean keep_if_only_one_option)
2181 ppd_option_t *other_option;
2184 ppd_const_t *constraint;
2185 const char *choice, *other_choice;
2186 ppd_option_t *option1, *option2;
2187 ppd_group_t *installed_options;
2189 gboolean all_default;
2195 conflicts = g_new0 (char, option->num_choices);
2197 installed_options = NULL;
2198 for (i = 0; i < ppd->num_groups; i++)
2202 name = ppd_group_name (&ppd->groups[i]);
2203 if (strcmp (name, "InstallableOptions") == 0)
2205 installed_options = &ppd->groups[i];
2210 for (i = ppd->num_consts, constraint = ppd->consts; i > 0; i--, constraint++)
2212 option1 = ppdFindOption (ppd, constraint->option1);
2213 if (option1 == NULL)
2216 option2 = ppdFindOption (ppd, constraint->option2);
2217 if (option2 == NULL)
2220 if (option == option1)
2222 choice = constraint->choice1;
2223 other_option = option2;
2224 other_choice = constraint->choice2;
2226 else if (option == option2)
2228 choice = constraint->choice2;
2229 other_option = option1;
2230 other_choice = constraint->choice1;
2235 /* We only care of conflicts with installed_options and
2237 if (!group_has_option (installed_options, other_option) &&
2238 (strcmp (other_option->keyword, "PageSize") != 0))
2241 if (*other_choice == 0)
2243 /* Conflict only if the installed option is not off */
2244 if (value_is_off (other_option->defchoice))
2247 /* Conflict if the installed option has the specified default */
2248 else if (strcasecmp (other_choice, other_option->defchoice) != 0)
2253 /* Conflict with all non-off choices */
2254 for (j = 0; j < option->num_choices; j++)
2256 if (!value_is_off (option->choices[j].choice))
2262 for (j = 0; j < option->num_choices; j++)
2264 if (strcasecmp (option->choices[j].choice, choice) == 0)
2272 for (j = 0; j < option->num_choices; j++)
2276 else if (strcmp (option->choices[j].choice, option->defchoice) != 0)
2277 all_default = FALSE;
2280 if ((all_default && !keep_if_only_one_option) ||
2281 (num_conflicts == option->num_choices))
2288 /* Some ppds don't have a "use printer default" option for
2289 * InputSlot. This means you always have to select a particular slot,
2290 * and you can't auto-pick source based on the paper size. To support
2291 * this we always add an auto option if there isn't one already. If
2292 * the user chooses the generated option we don't send any InputSlot
2293 * value when printing. The way we detect existing auto-cases is based
2294 * on feedback from Michael Sweet of cups fame.
2297 if (strcmp (option->keyword, "InputSlot") == 0)
2299 gboolean found_auto = FALSE;
2300 for (j = 0; j < option->num_choices; j++)
2304 if (strcmp (option->choices[j].choice, "Auto") == 0 ||
2305 strcmp (option->choices[j].choice, "AutoSelect") == 0 ||
2306 strcmp (option->choices[j].choice, "Default") == 0 ||
2307 strcmp (option->choices[j].choice, "None") == 0 ||
2308 strcmp (option->choices[j].choice, "PrinterDefault") == 0 ||
2309 strcmp (option->choices[j].choice, "Unspecified") == 0 ||
2310 option->choices[j].code == NULL ||
2311 option->choices[j].code[0] == 0)
2325 *available = g_new (ppd_choice_t *, option->num_choices - num_conflicts + add_auto);
2328 for (j = 0; j < option->num_choices; j++)
2331 (*available)[i++] = &option->choices[j];
2335 (*available)[i++] = NULL;
2340 return option->num_choices - num_conflicts + add_auto;
2343 static GtkPrinterOption *
2344 create_pickone_option (ppd_file_t *ppd_file,
2345 ppd_option_t *ppd_option,
2346 const gchar *gtk_name)
2348 GtkPrinterOption *option;
2349 ppd_choice_t **available;
2353 #ifdef HAVE_CUPS_API_1_2
2354 ppd_coption_t *coption;
2357 g_assert (ppd_option->ui == PPD_UI_PICKONE);
2361 n_choices = available_choices (ppd_file, ppd_option, &available, g_str_has_prefix (gtk_name, "gtk-"));
2365 /* right now only support one parameter per custom option
2366 * if more than one print warning and only offer the default choices
2369 label = get_option_text (ppd_file, ppd_option);
2371 #ifdef HAVE_CUPS_API_1_2
2372 coption = ppdFindCustomOption (ppd_file, ppd_option->keyword);
2376 ppd_cparam_t *cparam;
2378 cparam = ppdFirstCustomParam (coption);
2380 if (ppdNextCustomParam (coption) == NULL)
2382 switch (cparam->type)
2384 case PPD_CUSTOM_INT:
2385 option = gtk_printer_option_new (gtk_name, label,
2386 GTK_PRINTER_OPTION_TYPE_PICKONE_INT);
2388 case PPD_CUSTOM_PASSCODE:
2389 option = gtk_printer_option_new (gtk_name, label,
2390 GTK_PRINTER_OPTION_TYPE_PICKONE_PASSCODE);
2392 case PPD_CUSTOM_PASSWORD:
2393 option = gtk_printer_option_new (gtk_name, label,
2394 GTK_PRINTER_OPTION_TYPE_PICKONE_PASSWORD);
2396 case PPD_CUSTOM_REAL:
2397 option = gtk_printer_option_new (gtk_name, label,
2398 GTK_PRINTER_OPTION_TYPE_PICKONE_REAL);
2400 case PPD_CUSTOM_STRING:
2401 option = gtk_printer_option_new (gtk_name, label,
2402 GTK_PRINTER_OPTION_TYPE_PICKONE_STRING);
2404 #ifdef PRINT_IGNORED_OPTIONS
2405 case PPD_CUSTOM_POINTS:
2406 g_warning ("CUPS Backend: PPD Custom Points Option not supported");
2408 case PPD_CUSTOM_CURVE:
2409 g_warning ("CUPS Backend: PPD Custom Curve Option not supported");
2411 case PPD_CUSTOM_INVCURVE:
2412 g_warning ("CUPS Backend: PPD Custom Inverse Curve Option not supported");
2419 #ifdef PRINT_IGNORED_OPTIONS
2421 g_warning ("CUPS Backend: Multi-parameter PPD Custom Option not supported");
2424 #endif /* HAVE_CUPS_API_1_2 */
2427 option = gtk_printer_option_new (gtk_name, label,
2428 GTK_PRINTER_OPTION_TYPE_PICKONE);
2431 gtk_printer_option_allocate_choices (option, n_choices);
2432 for (i = 0; i < n_choices; i++)
2434 if (available[i] == NULL)
2436 /* This was auto-added */
2437 option->choices[i] = g_strdup ("gtk-ignore-value");
2438 option->choices_display[i] = g_strdup (_("Printer Default"));
2442 option->choices[i] = g_strdup (available[i]->choice);
2443 option->choices_display[i] = get_choice_text (ppd_file, available[i]);
2446 gtk_printer_option_set (option, ppd_option->defchoice);
2448 #ifdef PRINT_IGNORED_OPTIONS
2450 g_warning ("CUPS Backend: Ignoring pickone %s\n", ppd_option->text);
2457 static GtkPrinterOption *
2458 create_boolean_option (ppd_file_t *ppd_file,
2459 ppd_option_t *ppd_option,
2460 const gchar *gtk_name)
2462 GtkPrinterOption *option;
2463 ppd_choice_t **available;
2467 g_assert (ppd_option->ui == PPD_UI_BOOLEAN);
2471 n_choices = available_choices (ppd_file, ppd_option, &available, g_str_has_prefix (gtk_name, "gtk-"));
2474 label = get_option_text (ppd_file, ppd_option);
2475 option = gtk_printer_option_new (gtk_name, label,
2476 GTK_PRINTER_OPTION_TYPE_BOOLEAN);
2479 gtk_printer_option_allocate_choices (option, 2);
2480 option->choices[0] = g_strdup ("True");
2481 option->choices_display[0] = g_strdup ("True");
2482 option->choices[1] = g_strdup ("False");
2483 option->choices_display[1] = g_strdup ("False");
2485 gtk_printer_option_set (option, ppd_option->defchoice);
2487 #ifdef PRINT_IGNORED_OPTIONS
2489 g_warning ("CUPS Backend: Ignoring boolean %s\n", ppd_option->text);
2497 get_option_name (const gchar *keyword)
2501 for (i = 0; i < G_N_ELEMENTS (option_names); i++)
2502 if (strcmp (option_names[i].ppd_keyword, keyword) == 0)
2503 return g_strdup (option_names[i].name);
2505 return g_strdup_printf ("cups-%s", keyword);
2509 strptr_cmp (const void *a,
2512 char **aa = (char **)a;
2513 char **bb = (char **)b;
2514 return strcmp (*aa, *bb);
2519 string_in_table (gchar *str,
2520 const gchar *table[],
2523 return bsearch (&str, table, table_len, sizeof (char *), (void *)strptr_cmp) != NULL;
2526 #define STRING_IN_TABLE(_str, _table) (string_in_table (_str, _table, G_N_ELEMENTS (_table)))
2529 handle_option (GtkPrinterOptionSet *set,
2530 ppd_file_t *ppd_file,
2531 ppd_option_t *ppd_option,
2532 ppd_group_t *toplevel_group,
2533 GtkPrintSettings *settings)
2535 GtkPrinterOption *option;
2538 if (STRING_IN_TABLE (ppd_option->keyword, cups_option_blacklist))
2541 name = get_option_name (ppd_option->keyword);
2544 if (ppd_option->ui == PPD_UI_PICKONE)
2546 option = create_pickone_option (ppd_file, ppd_option, name);
2548 else if (ppd_option->ui == PPD_UI_BOOLEAN)
2550 option = create_boolean_option (ppd_file, ppd_option, name);
2552 #ifdef PRINT_IGNORED_OPTIONS
2554 g_warning ("CUPS Backend: Ignoring pickmany setting %s\n", ppd_option->text);
2561 name = ppd_group_name (toplevel_group);
2562 if (STRING_IN_TABLE (name,
2563 color_group_whitelist) ||
2564 STRING_IN_TABLE (ppd_option->keyword,
2565 color_option_whitelist))
2567 option->group = g_strdup ("ColorPage");
2569 else if (STRING_IN_TABLE (name,
2570 image_quality_group_whitelist) ||
2571 STRING_IN_TABLE (ppd_option->keyword,
2572 image_quality_option_whitelist))
2574 option->group = g_strdup ("ImageQualityPage");
2576 else if (STRING_IN_TABLE (name,
2577 finishing_group_whitelist) ||
2578 STRING_IN_TABLE (ppd_option->keyword,
2579 finishing_option_whitelist))
2581 option->group = g_strdup ("FinishingPage");
2585 option->group = g_strdup (toplevel_group->text);
2588 set_option_from_settings (option, settings);
2590 gtk_printer_option_set_add (set, option);
2597 handle_group (GtkPrinterOptionSet *set,
2598 ppd_file_t *ppd_file,
2600 ppd_group_t *toplevel_group,
2601 GtkPrintSettings *settings)
2606 /* Ignore installable options */
2607 name = ppd_group_name (toplevel_group);
2608 if (strcmp (name, "InstallableOptions") == 0)
2611 for (i = 0; i < group->num_options; i++)
2612 handle_option (set, ppd_file, &group->options[i], toplevel_group, settings);
2614 for (i = 0; i < group->num_subgroups; i++)
2615 handle_group (set, ppd_file, &group->subgroups[i], toplevel_group, settings);
2619 static GtkPrinterOptionSet *
2620 cups_printer_get_options (GtkPrinter *printer,
2621 GtkPrintSettings *settings,
2622 GtkPageSetup *page_setup,
2623 GtkPrintCapabilities capabilities)
2625 GtkPrinterOptionSet *set;
2626 GtkPrinterOption *option;
2627 ppd_file_t *ppd_file;
2629 char *print_at[] = { "now", "at", "on-hold" };
2630 char *n_up[] = {"1", "2", "4", "6", "9", "16" };
2631 char *prio[] = {"100", "80", "50", "30" };
2632 char *prio_display[] = {N_("Urgent"), N_("High"), N_("Medium"), N_("Low") };
2635 cups_option_t *opts = NULL;
2636 GtkPrintBackendCups *backend;
2639 set = gtk_printer_option_set_new ();
2641 /* Cups specific, non-ppd related settings */
2643 option = gtk_printer_option_new ("gtk-n-up", "Pages Per Sheet", GTK_PRINTER_OPTION_TYPE_PICKONE);
2644 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (n_up),
2646 gtk_printer_option_set (option, "1");
2647 set_option_from_settings (option, settings);
2648 gtk_printer_option_set_add (set, option);
2649 g_object_unref (option);
2651 for (i = 0; i < G_N_ELEMENTS(prio_display); i++)
2652 prio_display[i] = _(prio_display[i]);
2654 option = gtk_printer_option_new ("gtk-job-prio", "Job Priority", GTK_PRINTER_OPTION_TYPE_PICKONE);
2655 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (prio),
2656 prio, prio_display);
2657 gtk_printer_option_set (option, "50");
2658 set_option_from_settings (option, settings);
2659 gtk_printer_option_set_add (set, option);
2660 g_object_unref (option);
2662 option = gtk_printer_option_new ("gtk-billing-info", "Billing Info", GTK_PRINTER_OPTION_TYPE_STRING);
2663 gtk_printer_option_set (option, "");
2664 set_option_from_settings (option, settings);
2665 gtk_printer_option_set_add (set, option);
2666 g_object_unref (option);
2668 backend = GTK_PRINT_BACKEND_CUPS (gtk_printer_get_backend (printer));
2670 if (backend != NULL)
2672 char *cover_default[] = {"none", "classified", "confidential", "secret", "standard", "topsecret", "unclassified" };
2673 char *cover_display_default[] = {N_("None"), N_("Classified"), N_("Confidential"), N_("Secret"), N_("Standard"), N_("Top Secret"), N_("Unclassified"),};
2674 char **cover = NULL;
2675 char **cover_display = NULL;
2676 char **cover_display_translated = NULL;
2677 gint num_of_covers = 0;
2681 num_of_covers = backend->number_of_covers;
2682 cover = g_new (char *, num_of_covers + 1);
2683 cover[num_of_covers] = NULL;
2684 cover_display = g_new (char *, num_of_covers + 1);
2685 cover_display[num_of_covers] = NULL;
2686 cover_display_translated = g_new (char *, num_of_covers + 1);
2687 cover_display_translated[num_of_covers] = NULL;
2689 for (i = 0; i < num_of_covers; i++)
2691 cover[i] = g_strdup (backend->covers[i]);
2693 for (j = 0; j < G_N_ELEMENTS (cover_default); j++)
2694 if (strcmp (cover_default[j], cover[i]) == 0)
2696 value = cover_display_default[j];
2699 cover_display[i] = (value != NULL) ? g_strdup (value) : g_strdup (backend->covers[i]);
2702 for (i = 0; i < num_of_covers; i++)
2703 cover_display_translated[i] = _(cover_display[i]);
2705 option = gtk_printer_option_new ("gtk-cover-before", "Before", GTK_PRINTER_OPTION_TYPE_PICKONE);
2706 gtk_printer_option_choices_from_array (option, num_of_covers,
2707 cover, cover_display_translated);
2709 if (backend->default_cover_before != NULL)
2710 gtk_printer_option_set (option, backend->default_cover_before);
2712 gtk_printer_option_set (option, "none");
2713 set_option_from_settings (option, settings);
2714 gtk_printer_option_set_add (set, option);
2715 g_object_unref (option);
2717 option = gtk_printer_option_new ("gtk-cover-after", "After", GTK_PRINTER_OPTION_TYPE_PICKONE);
2718 gtk_printer_option_choices_from_array (option, num_of_covers,
2719 cover, cover_display_translated);
2720 if (backend->default_cover_after != NULL)
2721 gtk_printer_option_set (option, backend->default_cover_after);
2723 gtk_printer_option_set (option, "none");
2724 set_option_from_settings (option, settings);
2725 gtk_printer_option_set_add (set, option);
2726 g_object_unref (option);
2729 g_strfreev (cover_display);
2730 g_free (cover_display_translated);
2733 option = gtk_printer_option_new ("gtk-print-time", "Print at", GTK_PRINTER_OPTION_TYPE_PICKONE);
2734 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (print_at),
2735 print_at, print_at);
2736 gtk_printer_option_set (option, "now");
2737 set_option_from_settings (option, settings);
2738 gtk_printer_option_set_add (set, option);
2739 g_object_unref (option);
2741 option = gtk_printer_option_new ("gtk-print-time-text", "Print at time", GTK_PRINTER_OPTION_TYPE_STRING);
2742 gtk_printer_option_set (option, "");
2743 set_option_from_settings (option, settings);
2744 gtk_printer_option_set_add (set, option);
2745 g_object_unref (option);
2747 /* Printer (ppd) specific settings */
2748 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
2751 GtkPaperSize *paper_size;
2752 ppd_option_t *option;
2753 const gchar *ppd_name;
2755 ppdMarkDefaults (ppd_file);
2757 paper_size = gtk_page_setup_get_paper_size (page_setup);
2759 option = ppdFindOption (ppd_file, "PageSize");
2760 ppd_name = gtk_paper_size_get_ppd_name (paper_size);
2763 strncpy (option->defchoice, ppd_name, PPD_MAX_NAME);
2767 char width[G_ASCII_DTOSTR_BUF_SIZE];
2768 char height[G_ASCII_DTOSTR_BUF_SIZE];
2770 g_ascii_formatd (width, sizeof (width), "%.2f", gtk_paper_size_get_width (paper_size, GTK_UNIT_POINTS));
2771 g_ascii_formatd (height, sizeof (height), "%.2f", gtk_paper_size_get_height (paper_size, GTK_UNIT_POINTS));
2772 custom_name = g_strdup_printf (_("Custom %sx%s"), width, height);
2773 strncpy (option->defchoice, custom_name, PPD_MAX_NAME);
2774 g_free (custom_name);
2777 for (i = 0; i < ppd_file->num_groups; i++)
2778 handle_group (set, ppd_file, &ppd_file->groups[i], &ppd_file->groups[i], settings);
2781 /* Now honor the user set defaults for this printer */
2782 num_opts = cups_get_user_options (gtk_printer_get_name (printer), 0, &opts);
2784 for (i = 0; i < num_opts; i++)
2786 if (STRING_IN_TABLE (opts[i].name, cups_option_blacklist))
2789 name = get_option_name (opts[i].name);
2790 option = gtk_printer_option_set_lookup (set, name);
2792 gtk_printer_option_set (option, opts[i].value);
2796 cupsFreeOptions (num_opts, opts);
2803 mark_option_from_set (GtkPrinterOptionSet *set,
2804 ppd_file_t *ppd_file,
2805 ppd_option_t *ppd_option)
2807 GtkPrinterOption *option;
2808 char *name = get_option_name (ppd_option->keyword);
2810 option = gtk_printer_option_set_lookup (set, name);
2813 ppdMarkOption (ppd_file, ppd_option->keyword, option->value);
2820 mark_group_from_set (GtkPrinterOptionSet *set,
2821 ppd_file_t *ppd_file,
2826 for (i = 0; i < group->num_options; i++)
2827 mark_option_from_set (set, ppd_file, &group->options[i]);
2829 for (i = 0; i < group->num_subgroups; i++)
2830 mark_group_from_set (set, ppd_file, &group->subgroups[i]);
2834 set_conflicts_from_option (GtkPrinterOptionSet *set,
2835 ppd_file_t *ppd_file,
2836 ppd_option_t *ppd_option)
2838 GtkPrinterOption *option;
2841 if (ppd_option->conflicted)
2843 name = get_option_name (ppd_option->keyword);
2844 option = gtk_printer_option_set_lookup (set, name);
2847 gtk_printer_option_set_has_conflict (option, TRUE);
2848 #ifdef PRINT_IGNORED_OPTIONS
2850 g_warning ("CUPS Backend: Ignoring conflict for option %s", ppd_option->keyword);
2858 set_conflicts_from_group (GtkPrinterOptionSet *set,
2859 ppd_file_t *ppd_file,
2864 for (i = 0; i < group->num_options; i++)
2865 set_conflicts_from_option (set, ppd_file, &group->options[i]);
2867 for (i = 0; i < group->num_subgroups; i++)
2868 set_conflicts_from_group (set, ppd_file, &group->subgroups[i]);
2872 cups_printer_mark_conflicts (GtkPrinter *printer,
2873 GtkPrinterOptionSet *options)
2875 ppd_file_t *ppd_file;
2879 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
2881 if (ppd_file == NULL)
2884 ppdMarkDefaults (ppd_file);
2886 for (i = 0; i < ppd_file->num_groups; i++)
2887 mark_group_from_set (options, ppd_file, &ppd_file->groups[i]);
2889 num_conflicts = ppdConflicts (ppd_file);
2891 if (num_conflicts > 0)
2893 for (i = 0; i < ppd_file->num_groups; i++)
2894 set_conflicts_from_group (options, ppd_file, &ppd_file->groups[i]);
2897 return num_conflicts > 0;
2901 GtkPrinter *printer;
2902 GtkPrinterOptionSet *options;
2903 GtkPrintSettings *settings;
2904 ppd_file_t *ppd_file;
2909 const char *standard;
2913 map_settings_to_option (GtkPrinterOption *option,
2914 const NameMapping table[],
2916 GtkPrintSettings *settings,
2917 const gchar *standard_name,
2918 const gchar *cups_name)
2922 const char *cups_value;
2923 const char *standard_value;
2925 /* If the cups-specific setting is set, always use that */
2926 name = g_strdup_printf ("cups-%s", cups_name);
2927 cups_value = gtk_print_settings_get (settings, name);
2930 if (cups_value != NULL)
2932 gtk_printer_option_set (option, cups_value);
2936 /* Otherwise we try to convert from the general setting */
2937 standard_value = gtk_print_settings_get (settings, standard_name);
2938 if (standard_value == NULL)
2941 for (i = 0; i < n_elements; i++)
2943 if (table[i].cups == NULL && table[i].standard == NULL)
2945 gtk_printer_option_set (option, standard_value);
2948 else if (table[i].cups == NULL &&
2949 strcmp (table[i].standard, standard_value) == 0)
2951 set_option_off (option);
2954 else if (strcmp (table[i].standard, standard_value) == 0)
2956 gtk_printer_option_set (option, table[i].cups);
2963 map_option_to_settings (const gchar *value,
2964 const NameMapping table[],
2966 GtkPrintSettings *settings,
2967 const gchar *standard_name,
2968 const gchar *cups_name)
2973 for (i = 0; i < n_elements; i++)
2975 if (table[i].cups == NULL && table[i].standard == NULL)
2977 gtk_print_settings_set (settings,
2982 else if (table[i].cups == NULL && table[i].standard != NULL)
2984 if (value_is_off (value))
2986 gtk_print_settings_set (settings,
2992 else if (strcmp (table[i].cups, value) == 0)
2994 gtk_print_settings_set (settings,
3001 /* Always set the corresponding cups-specific setting */
3002 name = g_strdup_printf ("cups-%s", cups_name);
3003 gtk_print_settings_set (settings, name, value);
3008 static const NameMapping paper_source_map[] = {
3009 { "Lower", "lower"},
3010 { "Middle", "middle"},
3011 { "Upper", "upper"},
3013 { "Envelope", "envelope"},
3014 { "Cassette", "cassette"},
3015 { "LargeCapacity", "large-capacity"},
3016 { "AnySmallFormat", "small-format"},
3017 { "AnyLargeFormat", "large-format"},
3021 static const NameMapping output_tray_map[] = {
3022 { "Upper", "upper"},
3023 { "Lower", "lower"},
3028 static const NameMapping duplex_map[] = {
3029 { "DuplexTumble", "vertical" },
3030 { "DuplexNoTumble", "horizontal" },
3034 static const NameMapping output_mode_map[] = {
3035 { "Standard", "normal" },
3036 { "Normal", "normal" },
3037 { "Draft", "draft" },
3038 { "Fast", "draft" },
3041 static const NameMapping media_type_map[] = {
3042 { "Transparency", "transparency"},
3043 { "Standard", "stationery"},
3047 static const NameMapping all_map[] = {
3053 set_option_from_settings (GtkPrinterOption *option,
3054 GtkPrintSettings *settings)
3056 const char *cups_value;
3059 if (settings == NULL)
3062 if (strcmp (option->name, "gtk-paper-source") == 0)
3063 map_settings_to_option (option, paper_source_map, G_N_ELEMENTS (paper_source_map),
3064 settings, GTK_PRINT_SETTINGS_DEFAULT_SOURCE, "InputSlot");
3065 else if (strcmp (option->name, "gtk-output-tray") == 0)
3066 map_settings_to_option (option, output_tray_map, G_N_ELEMENTS (output_tray_map),
3067 settings, GTK_PRINT_SETTINGS_OUTPUT_BIN, "OutputBin");
3068 else if (strcmp (option->name, "gtk-duplex") == 0)
3069 map_settings_to_option (option, duplex_map, G_N_ELEMENTS (duplex_map),
3070 settings, GTK_PRINT_SETTINGS_DUPLEX, "Duplex");
3071 else if (strcmp (option->name, "cups-OutputMode") == 0)
3072 map_settings_to_option (option, output_mode_map, G_N_ELEMENTS (output_mode_map),
3073 settings, GTK_PRINT_SETTINGS_QUALITY, "OutputMode");
3074 else if (strcmp (option->name, "cups-Resolution") == 0)
3076 cups_value = gtk_print_settings_get (settings, option->name);
3078 gtk_printer_option_set (option, cups_value);
3081 int res = gtk_print_settings_get_resolution (settings);
3084 value = g_strdup_printf ("%ddpi", res);
3085 gtk_printer_option_set (option, value);
3090 else if (strcmp (option->name, "gtk-paper-type") == 0)
3091 map_settings_to_option (option, media_type_map, G_N_ELEMENTS (media_type_map),
3092 settings, GTK_PRINT_SETTINGS_MEDIA_TYPE, "MediaType");
3093 else if (strcmp (option->name, "gtk-n-up") == 0)
3095 map_settings_to_option (option, all_map, G_N_ELEMENTS (all_map),
3096 settings, GTK_PRINT_SETTINGS_NUMBER_UP, "number-up");
3098 else if (strcmp (option->name, "gtk-billing-info") == 0)
3100 cups_value = gtk_print_settings_get (settings, "cups-job-billing");
3102 gtk_printer_option_set (option, cups_value);
3104 else if (strcmp (option->name, "gtk-job-prio") == 0)
3106 cups_value = gtk_print_settings_get (settings, "cups-job-priority");
3108 gtk_printer_option_set (option, cups_value);
3110 else if (strcmp (option->name, "gtk-cover-before") == 0)
3112 cups_value = gtk_print_settings_get (settings, "cover-before");
3114 gtk_printer_option_set (option, cups_value);
3116 else if (strcmp (option->name, "gtk-cover-after") == 0)
3118 cups_value = gtk_print_settings_get (settings, "cover-after");
3120 gtk_printer_option_set (option, cups_value);
3122 else if (strcmp (option->name, "gtk-print-time") == 0)
3124 cups_value = gtk_print_settings_get (settings, "print-at");
3126 gtk_printer_option_set (option, cups_value);
3128 else if (strcmp (option->name, "gtk-print-time-text") == 0)
3130 cups_value = gtk_print_settings_get (settings, "print-at-time");
3132 gtk_printer_option_set (option, cups_value);
3134 else if (g_str_has_prefix (option->name, "cups-"))
3136 cups_value = gtk_print_settings_get (settings, option->name);
3138 gtk_printer_option_set (option, cups_value);
3143 foreach_option_get_settings (GtkPrinterOption *option,
3146 struct OptionData *data = user_data;
3147 GtkPrintSettings *settings = data->settings;
3150 value = option->value;
3152 if (strcmp (option->name, "gtk-paper-source") == 0)
3153 map_option_to_settings (value, paper_source_map, G_N_ELEMENTS (paper_source_map),
3154 settings, GTK_PRINT_SETTINGS_DEFAULT_SOURCE, "InputSlot");
3155 else if (strcmp (option->name, "gtk-output-tray") == 0)
3156 map_option_to_settings (value, output_tray_map, G_N_ELEMENTS (output_tray_map),
3157 settings, GTK_PRINT_SETTINGS_OUTPUT_BIN, "OutputBin");
3158 else if (strcmp (option->name, "gtk-duplex") == 0)
3159 map_option_to_settings (value, duplex_map, G_N_ELEMENTS (duplex_map),
3160 settings, GTK_PRINT_SETTINGS_DUPLEX, "Duplex");
3161 else if (strcmp (option->name, "cups-OutputMode") == 0)
3162 map_option_to_settings (value, output_mode_map, G_N_ELEMENTS (output_mode_map),
3163 settings, GTK_PRINT_SETTINGS_QUALITY, "OutputMode");
3164 else if (strcmp (option->name, "cups-Resolution") == 0)
3166 int res = atoi (value);
3167 /* TODO: What if resolution is on XXXxYYYdpi form? */
3169 gtk_print_settings_set_resolution (settings, res);
3170 gtk_print_settings_set (settings, option->name, value);
3172 else if (strcmp (option->name, "gtk-paper-type") == 0)
3173 map_option_to_settings (value, media_type_map, G_N_ELEMENTS (media_type_map),
3174 settings, GTK_PRINT_SETTINGS_MEDIA_TYPE, "MediaType");
3175 else if (strcmp (option->name, "gtk-n-up") == 0)
3176 map_option_to_settings (value, all_map, G_N_ELEMENTS (all_map),
3177 settings, GTK_PRINT_SETTINGS_NUMBER_UP, "number-up");
3178 else if (strcmp (option->name, "gtk-billing-info") == 0 && strlen (value) > 0)
3179 gtk_print_settings_set (settings, "cups-job-billing", value);
3180 else if (strcmp (option->name, "gtk-job-prio") == 0)
3181 gtk_print_settings_set (settings, "cups-job-priority", value);
3182 else if (strcmp (option->name, "gtk-cover-before") == 0)
3183 gtk_print_settings_set (settings, "cover-before", value);
3184 else if (strcmp (option->name, "gtk-cover-after") == 0)
3185 gtk_print_settings_set (settings, "cover-after", value);
3186 else if (strcmp (option->name, "gtk-print-time") == 0)
3187 gtk_print_settings_set (settings, "print-at", value);
3188 else if (strcmp (option->name, "gtk-print-time-text") == 0)
3189 gtk_print_settings_set (settings, "print-at-time", value);
3190 else if (g_str_has_prefix (option->name, "cups-"))
3191 gtk_print_settings_set (settings, option->name, value);
3195 cups_printer_get_settings_from_options (GtkPrinter *printer,
3196 GtkPrinterOptionSet *options,
3197 GtkPrintSettings *settings)
3199 struct OptionData data;
3200 const char *print_at, *print_at_time;
3202 data.printer = printer;
3203 data.options = options;
3204 data.settings = settings;
3205 data.ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
3207 if (data.ppd_file != NULL)
3209 GtkPrinterOption *cover_before, *cover_after;
3211 gtk_printer_option_set_foreach (options, foreach_option_get_settings, &data);
3213 cover_before = gtk_printer_option_set_lookup (options, "gtk-cover-before");
3214 cover_after = gtk_printer_option_set_lookup (options, "gtk-cover-after");
3215 if (cover_before && cover_after)
3217 char *value = g_strdup_printf ("%s,%s", cover_before->value, cover_after->value);
3218 gtk_print_settings_set (settings, "cups-job-sheets", value);
3222 print_at = gtk_print_settings_get (settings, "print-at");
3223 print_at_time = gtk_print_settings_get (settings, "print-at-time");
3224 if (strcmp (print_at, "at") == 0)
3225 gtk_print_settings_set (settings, "cups-job-hold-until", print_at_time);
3226 else if (strcmp (print_at, "on-hold") == 0)
3227 gtk_print_settings_set (settings, "cups-job-hold-until", "indefinite");
3232 cups_printer_prepare_for_print (GtkPrinter *printer,
3233 GtkPrintJob *print_job,
3234 GtkPrintSettings *settings,
3235 GtkPageSetup *page_setup)
3237 GtkPageSet page_set;
3238 GtkPaperSize *paper_size;
3239 const char *ppd_paper_name;
3242 print_job->print_pages = gtk_print_settings_get_print_pages (settings);
3243 print_job->page_ranges = NULL;
3244 print_job->num_page_ranges = 0;
3246 if (print_job->print_pages == GTK_PRINT_PAGES_RANGES)
3247 print_job->page_ranges =
3248 gtk_print_settings_get_page_ranges (settings,
3249 &print_job->num_page_ranges);
3251 if (gtk_print_settings_get_collate (settings))
3252 gtk_print_settings_set (settings, "cups-Collate", "True");
3253 print_job->collate = FALSE;
3255 if (gtk_print_settings_get_reverse (settings))
3256 gtk_print_settings_set (settings, "cups-OutputOrder", "Reverse");
3257 print_job->reverse = FALSE;
3259 if (gtk_print_settings_get_n_copies (settings) > 1)
3260 gtk_print_settings_set_int (settings, "cups-copies",
3261 gtk_print_settings_get_n_copies (settings));
3262 print_job->num_copies = 1;
3264 scale = gtk_print_settings_get_scale (settings);
3265 print_job->scale = 1.0;
3267 print_job->scale = scale/100.0;
3269 page_set = gtk_print_settings_get_page_set (settings);
3270 if (page_set == GTK_PAGE_SET_EVEN)
3271 gtk_print_settings_set (settings, "cups-page-set", "even");
3272 else if (page_set == GTK_PAGE_SET_ODD)
3273 gtk_print_settings_set (settings, "cups-page-set", "odd");
3274 print_job->page_set = GTK_PAGE_SET_ALL;
3276 paper_size = gtk_page_setup_get_paper_size (page_setup);
3277 ppd_paper_name = gtk_paper_size_get_ppd_name (paper_size);
3278 if (ppd_paper_name != NULL)
3279 gtk_print_settings_set (settings, "cups-PageSize", ppd_paper_name);
3282 char width[G_ASCII_DTOSTR_BUF_SIZE];
3283 char height[G_ASCII_DTOSTR_BUF_SIZE];
3286 g_ascii_formatd (width, sizeof (width), "%.2f", gtk_paper_size_get_width (paper_size, GTK_UNIT_POINTS));
3287 g_ascii_formatd (height, sizeof (height), "%.2f", gtk_paper_size_get_height (paper_size, GTK_UNIT_POINTS));
3288 custom_name = g_strdup_printf (("Custom.%sx%s"), width, height);
3289 gtk_print_settings_set (settings, "cups-PageSize", custom_name);
3290 g_free (custom_name);
3293 print_job->rotate_to_orientation = TRUE;
3296 static GtkPageSetup *
3297 create_page_setup (ppd_file_t *ppd_file,
3301 GtkPageSetup *page_setup;
3302 GtkPaperSize *paper_size;
3303 ppd_option_t *option;
3304 ppd_choice_t *choice;
3306 display_name = NULL;
3307 option = ppdFindOption (ppd_file, "PageSize");
3310 choice = ppdFindChoice (option, size->name);
3312 display_name = ppd_text_to_utf8 (ppd_file, choice->text);
3315 if (display_name == NULL)
3316 display_name = g_strdup (size->name);
3318 page_setup = gtk_page_setup_new ();
3319 paper_size = gtk_paper_size_new_from_ppd (size->name,
3323 gtk_page_setup_set_paper_size (page_setup, paper_size);
3324 gtk_paper_size_free (paper_size);
3326 gtk_page_setup_set_top_margin (page_setup, size->length - size->top, GTK_UNIT_POINTS);
3327 gtk_page_setup_set_bottom_margin (page_setup, size->bottom, GTK_UNIT_POINTS);
3328 gtk_page_setup_set_left_margin (page_setup, size->left, GTK_UNIT_POINTS);
3329 gtk_page_setup_set_right_margin (page_setup, size->width - size->right, GTK_UNIT_POINTS);
3331 g_free (display_name);
3337 cups_printer_list_papers (GtkPrinter *printer)
3339 ppd_file_t *ppd_file;
3341 GtkPageSetup *page_setup;
3345 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
3346 if (ppd_file == NULL)
3351 for (i = 0; i < ppd_file->num_sizes; i++)
3353 size = &ppd_file->sizes[i];
3355 page_setup = create_page_setup (ppd_file, size);
3357 l = g_list_prepend (l, page_setup);
3360 return g_list_reverse (l);
3363 static GtkPageSetup *
3364 cups_printer_get_default_page_size (GtkPrinter *printer)
3366 ppd_file_t *ppd_file;
3368 ppd_option_t *option;
3371 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
3372 if (ppd_file == NULL)
3375 option = ppdFindOption (ppd_file, "PageSize");
3376 size = ppdPageSize (ppd_file, option->defchoice);
3378 return create_page_setup (ppd_file, size);
3382 cups_printer_get_hard_margins (GtkPrinter *printer,
3388 ppd_file_t *ppd_file;
3390 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
3391 if (ppd_file == NULL)
3394 *left = ppd_file->custom_margins[0];
3395 *bottom = ppd_file->custom_margins[1];
3396 *right = ppd_file->custom_margins[2];
3397 *top = ppd_file->custom_margins[3];
3400 static GtkPrintCapabilities
3401 cups_printer_get_capabilities (GtkPrinter *printer)
3404 GTK_PRINT_CAPABILITY_COPIES |
3405 GTK_PRINT_CAPABILITY_COLLATE |
3406 GTK_PRINT_CAPABILITY_REVERSE |
3407 GTK_PRINT_CAPABILITY_NUMBER_UP;