1 /* GTK - The GIMP Toolkit
2 * gtkprintbackendcups.h: Default implementation of GtkPrintBackend
3 * for the Common Unix Print System (CUPS)
4 * Copyright (C) 2003, 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.
23 #include <sys/types.h>
28 #include <cups/cups.h>
29 #include <cups/language.h>
30 #include <cups/http.h>
34 #include <cairo-pdf.h>
37 #include <glib/gi18n-lib.h>
40 #include <gtk/gtkprintoperation.h>
41 #include <gtk/gtkprintsettings.h>
42 #include <gtk/gtkprintbackend.h>
43 #include <gtk/gtkprinter.h>
44 #include <gtk/gtkprinter-private.h>
46 #include "gtkprintbackendcups.h"
47 #include "gtkprintercups.h"
49 #include "gtkcupsutils.h"
52 typedef struct _GtkPrintBackendCupsClass GtkPrintBackendCupsClass;
54 #define GTK_PRINT_BACKEND_CUPS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_BACKEND_CUPS, GtkPrintBackendCupsClass))
55 #define GTK_IS_PRINT_BACKEND_CUPS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_BACKEND_CUPS))
56 #define GTK_PRINT_BACKEND_CUPS_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_BACKEND_CUPS, GtkPrintBackendCupsClass))
58 #define _CUPS_MAX_ATTEMPTS 10
59 #define _CUPS_MAX_CHUNK_SIZE 8192
61 #define _CUPS_MAP_ATTR_INT(attr, v, a) {if (!g_ascii_strcasecmp (attr->name, (a))) v = attr->values[0].integer;}
62 #define _CUPS_MAP_ATTR_STR(attr, v, a) {if (!g_ascii_strcasecmp (attr->name, (a))) v = attr->values[0].string.text;}
64 static GType print_backend_cups_type = 0;
66 typedef void (* GtkPrintCupsResponseCallbackFunc) (GtkPrintBackend *print_backend,
67 GtkCupsResult *result,
78 } GtkPrintCupsDispatchState;
85 GtkCupsRequest *request;
87 GtkPrintBackendCups *backend;
89 } GtkPrintCupsDispatchWatch;
91 struct _GtkPrintBackendCupsClass
93 GtkPrintBackendClass parent_class;
96 struct _GtkPrintBackendCups
98 GtkPrintBackend parent_instance;
100 char *default_printer;
102 guint list_printers_poll;
103 guint list_printers_pending : 1;
104 guint got_default_printer : 1;
107 static GObjectClass *backend_parent_class;
109 static void gtk_print_backend_cups_class_init (GtkPrintBackendCupsClass *class);
110 static void gtk_print_backend_cups_init (GtkPrintBackendCups *impl);
111 static void gtk_print_backend_cups_finalize (GObject *object);
112 static void gtk_print_backend_cups_dispose (GObject *object);
113 static void cups_get_printer_list (GtkPrintBackend *print_backend);
114 static void cups_request_execute (GtkPrintBackendCups *print_backend,
115 GtkCupsRequest *request,
116 GtkPrintCupsResponseCallbackFunc callback,
118 GDestroyNotify notify);
119 static void cups_printer_get_settings_from_options (GtkPrinter *printer,
120 GtkPrinterOptionSet *options,
121 GtkPrintSettings *settings);
122 static gboolean cups_printer_mark_conflicts (GtkPrinter *printer,
123 GtkPrinterOptionSet *options);
124 static GtkPrinterOptionSet *cups_printer_get_options (GtkPrinter *printer,
125 GtkPrintSettings *settings,
126 GtkPageSetup *page_setup);
127 static void cups_printer_prepare_for_print (GtkPrinter *printer,
128 GtkPrintJob *print_job,
129 GtkPrintSettings *settings,
130 GtkPageSetup *page_setup);
131 static GList * cups_printer_list_papers (GtkPrinter *printer);
132 static void cups_printer_request_details (GtkPrinter *printer);
133 static void cups_request_default_printer (GtkPrintBackendCups *print_backend);
134 static void cups_request_ppd (GtkPrinter *printer);
135 static void cups_printer_get_hard_margins (GtkPrinter *printer,
140 static GtkPrintCapabilities cups_printer_get_capabilities (GtkPrinter *printer);
141 static void set_option_from_settings (GtkPrinterOption *option,
142 GtkPrintSettings *setting);
143 static void cups_begin_polling_info (GtkPrintBackendCups *print_backend,
146 static gboolean cups_job_info_poll_timeout (gpointer user_data);
147 static void gtk_print_backend_cups_print_stream (GtkPrintBackend *backend,
150 GtkPrintJobCompleteFunc callback,
152 GDestroyNotify dnotify);
153 static cairo_surface_t * cups_printer_create_cairo_surface (GtkPrinter *printer,
154 GtkPrintSettings *settings,
161 gtk_print_backend_cups_register_type (GTypeModule *module)
163 static const GTypeInfo print_backend_cups_info =
165 sizeof (GtkPrintBackendCupsClass),
166 NULL, /* base_init */
167 NULL, /* base_finalize */
168 (GClassInitFunc) gtk_print_backend_cups_class_init,
169 NULL, /* class_finalize */
170 NULL, /* class_data */
171 sizeof (GtkPrintBackendCups),
173 (GInstanceInitFunc) gtk_print_backend_cups_init
176 print_backend_cups_type = g_type_module_register_type (module,
177 GTK_TYPE_PRINT_BACKEND,
178 "GtkPrintBackendCups",
179 &print_backend_cups_info, 0);
183 pb_module_init (GTypeModule *module)
185 gtk_print_backend_cups_register_type (module);
186 gtk_printer_cups_register_type (module);
190 pb_module_exit (void)
195 G_MODULE_EXPORT GtkPrintBackend *
196 pb_module_create (void)
198 return gtk_print_backend_cups_new ();
202 * GtkPrintBackendCups
205 gtk_print_backend_cups_get_type (void)
207 return print_backend_cups_type;
211 * gtk_print_backend_cups_new:
213 * Creates a new #GtkPrintBackendCups object. #GtkPrintBackendCups
214 * implements the #GtkPrintBackend interface with direct access to
215 * the filesystem using Unix/Linux API calls
217 * Return value: the new #GtkPrintBackendCups object
220 gtk_print_backend_cups_new (void)
222 return g_object_new (GTK_TYPE_PRINT_BACKEND_CUPS, NULL);
226 gtk_print_backend_cups_class_init (GtkPrintBackendCupsClass *class)
228 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
229 GtkPrintBackendClass *backend_class = GTK_PRINT_BACKEND_CLASS (class);
231 backend_parent_class = g_type_class_peek_parent (class);
233 gobject_class->finalize = gtk_print_backend_cups_finalize;
234 gobject_class->dispose = gtk_print_backend_cups_dispose;
236 backend_class->request_printer_list = cups_get_printer_list;
237 backend_class->print_stream = gtk_print_backend_cups_print_stream;
238 backend_class->printer_request_details = cups_printer_request_details;
239 backend_class->printer_create_cairo_surface = cups_printer_create_cairo_surface;
240 backend_class->printer_get_options = cups_printer_get_options;
241 backend_class->printer_mark_conflicts = cups_printer_mark_conflicts;
242 backend_class->printer_get_settings_from_options = cups_printer_get_settings_from_options;
243 backend_class->printer_prepare_for_print = cups_printer_prepare_for_print;
244 backend_class->printer_list_papers = cups_printer_list_papers;
245 backend_class->printer_get_hard_margins = cups_printer_get_hard_margins;
246 backend_class->printer_get_capabilities = cups_printer_get_capabilities;
249 static cairo_status_t
250 _cairo_write_to_cups (void *closure,
251 const unsigned char *data,
254 gint fd = GPOINTER_TO_INT (closure);
259 written = write (fd, data, length);
263 if (errno == EAGAIN || errno == EINTR)
266 return CAIRO_STATUS_WRITE_ERROR;
273 return CAIRO_STATUS_SUCCESS;
276 static cairo_surface_t *
277 cups_printer_create_cairo_surface (GtkPrinter *printer,
278 GtkPrintSettings *settings,
283 cairo_surface_t *surface;
285 /* TODO: check if it is a ps or pdf printer */
287 surface = cairo_ps_surface_create_for_stream (_cairo_write_to_cups, GINT_TO_POINTER (cache_fd), width, height);
289 /* TODO: DPI from settings object? */
290 cairo_surface_set_fallback_resolution (surface, 300, 300);
296 GtkPrintJobCompleteFunc callback;
299 GDestroyNotify dnotify;
300 } CupsPrintStreamData;
303 cups_free_print_stream_data (CupsPrintStreamData *data)
306 data->dnotify (data->user_data);
307 g_object_unref (data->job);
312 cups_print_cb (GtkPrintBackendCups *print_backend,
313 GtkCupsResult *result,
316 GError *error = NULL;
317 CupsPrintStreamData *ps = user_data;
319 if (gtk_cups_result_is_error (result))
320 error = g_error_new_literal (gtk_print_error_quark (),
321 GTK_PRINT_ERROR_INTERNAL_ERROR,
322 gtk_cups_result_get_error_string (result));
325 ps->callback (ps->job, ps->user_data, error);
330 ipp_attribute_t *attr; /* IPP job-id attribute */
331 ipp_t *response = gtk_cups_result_get_response (result);
333 if ((attr = ippFindAttribute (response, "job-id", IPP_TAG_INTEGER)) != NULL)
334 job_id = attr->values[0].integer;
336 if (!gtk_print_job_get_track_print_status (ps->job) || job_id == 0)
337 gtk_print_job_set_status (ps->job, GTK_PRINT_STATUS_FINISHED);
340 gtk_print_job_set_status (ps->job, GTK_PRINT_STATUS_PENDING);
341 cups_begin_polling_info (print_backend, ps->job, job_id);
345 gtk_print_job_set_status (ps->job, GTK_PRINT_STATUS_FINISHED_ABORTED);
349 g_error_free (error);
354 add_cups_options (const gchar *key,
358 GtkCupsRequest *request = user_data;
360 if (!g_str_has_prefix (key, "cups-"))
363 if (strcmp (value, "gtk-ignore-value") == 0)
366 key = key + strlen ("cups-");
368 gtk_cups_request_encode_option (request, key, value);
372 gtk_print_backend_cups_print_stream (GtkPrintBackend *print_backend,
375 GtkPrintJobCompleteFunc callback,
377 GDestroyNotify dnotify)
379 GtkPrinterCups *cups_printer;
380 CupsPrintStreamData *ps;
381 GtkCupsRequest *request;
382 GtkPrintSettings *settings;
385 cups_printer = GTK_PRINTER_CUPS (gtk_print_job_get_printer (job));
386 settings = gtk_print_job_get_settings (job);
388 request = gtk_cups_request_new (NULL,
393 cups_printer->device_uri);
395 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
396 NULL, cups_printer->printer_uri);
398 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name",
401 title = gtk_print_job_get_title (job);
403 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION, IPP_TAG_NAME, "job-name", NULL,
406 gtk_print_settings_foreach (settings, add_cups_options, request);
408 ps = g_new0 (CupsPrintStreamData, 1);
409 ps->callback = callback;
410 ps->user_data = user_data;
411 ps->dnotify = dnotify;
412 ps->job = g_object_ref (job);
414 cups_request_execute (GTK_PRINT_BACKEND_CUPS (print_backend),
416 (GtkPrintCupsResponseCallbackFunc) cups_print_cb,
418 (GDestroyNotify)cups_free_print_stream_data);
423 gtk_print_backend_cups_init (GtkPrintBackendCups *backend_cups)
425 backend_cups->list_printers_poll = 0;
426 backend_cups->list_printers_pending = FALSE;
428 cups_request_default_printer (backend_cups);
432 gtk_print_backend_cups_finalize (GObject *object)
434 GtkPrintBackendCups *backend_cups;
436 backend_cups = GTK_PRINT_BACKEND_CUPS (object);
438 g_free (backend_cups->default_printer);
439 backend_cups->default_printer = NULL;
441 backend_parent_class->finalize (object);
445 gtk_print_backend_cups_dispose (GObject *object)
447 GtkPrintBackendCups *backend_cups;
449 backend_cups = GTK_PRINT_BACKEND_CUPS (object);
451 if (backend_cups->list_printers_poll > 0)
452 g_source_remove (backend_cups->list_printers_poll);
453 backend_cups->list_printers_poll = 0;
455 backend_parent_class->dispose (object);
460 cups_dispatch_watch_check (GSource *source)
462 GtkPrintCupsDispatchWatch *dispatch;
463 GtkCupsPollState poll_state;
466 dispatch = (GtkPrintCupsDispatchWatch *) source;
468 poll_state = gtk_cups_request_get_poll_state (dispatch->request);
470 if (dispatch->data_poll == NULL &&
471 dispatch->request->http != NULL)
473 dispatch->data_poll = g_new0 (GPollFD, 1);
474 dispatch->data_poll->fd = dispatch->request->http->fd;
476 g_source_add_poll (source, dispatch->data_poll);
479 if (dispatch->data_poll != NULL && dispatch->request->http != NULL)
481 if (dispatch->data_poll->fd != dispatch->request->http->fd)
482 dispatch->data_poll->fd = dispatch->request->http->fd;
484 if (poll_state == GTK_CUPS_HTTP_READ)
485 dispatch->data_poll->events = G_IO_IN | G_IO_HUP | G_IO_ERR | G_IO_PRI;
486 else if (poll_state == GTK_CUPS_HTTP_WRITE)
487 dispatch->data_poll->events = G_IO_OUT | G_IO_ERR;
489 dispatch->data_poll->events = 0;
492 if (poll_state != GTK_CUPS_HTTP_IDLE)
493 if (!(dispatch->data_poll->revents & dispatch->data_poll->events))
496 result = gtk_cups_request_read_write (dispatch->request);
497 if (result && dispatch->data_poll != NULL)
499 g_source_remove_poll (source, dispatch->data_poll);
500 g_free (dispatch->data_poll);
501 dispatch->data_poll = NULL;
508 cups_dispatch_watch_prepare (GSource *source,
511 GtkPrintCupsDispatchWatch *dispatch;
513 dispatch = (GtkPrintCupsDispatchWatch *) source;
517 return gtk_cups_request_read_write (dispatch->request);
521 cups_dispatch_watch_dispatch (GSource *source,
522 GSourceFunc callback,
525 GtkPrintCupsDispatchWatch *dispatch;
526 GtkPrintCupsResponseCallbackFunc ep_callback;
527 GtkCupsResult *result;
529 g_assert (callback != NULL);
531 ep_callback = (GtkPrintCupsResponseCallbackFunc) callback;
533 dispatch = (GtkPrintCupsDispatchWatch *) source;
535 result = gtk_cups_request_get_result (dispatch->request);
537 if (gtk_cups_result_is_error (result))
538 g_warning (gtk_cups_result_get_error_string (result));
540 ep_callback (GTK_PRINT_BACKEND (dispatch->backend), result, user_data);
546 cups_dispatch_watch_finalize (GSource *source)
548 GtkPrintCupsDispatchWatch *dispatch;
550 dispatch = (GtkPrintCupsDispatchWatch *) source;
552 gtk_cups_request_free (dispatch->request);
554 if (dispatch->backend)
556 /* We need to unref this at idle time, because it might be the
557 * last reference to this module causing the code to be
558 * unloaded (including this particular function!)
559 * Update: Doing this at idle caused a deadlock taking the
560 * mainloop context lock while being in a GSource callout for
561 * multithreaded apps. So, for now we just disable unloading
562 * of print backends. See _gtk_print_backend_create for the
565 g_object_unref (dispatch->backend);
566 dispatch->backend = NULL;
569 if (dispatch->data_poll != NULL)
570 g_free (dispatch->data_poll);
573 static GSourceFuncs _cups_dispatch_watch_funcs = {
574 cups_dispatch_watch_prepare,
575 cups_dispatch_watch_check,
576 cups_dispatch_watch_dispatch,
577 cups_dispatch_watch_finalize
582 cups_request_execute (GtkPrintBackendCups *print_backend,
583 GtkCupsRequest *request,
584 GtkPrintCupsResponseCallbackFunc callback,
586 GDestroyNotify notify)
588 GtkPrintCupsDispatchWatch *dispatch;
590 dispatch = (GtkPrintCupsDispatchWatch *) g_source_new (&_cups_dispatch_watch_funcs,
591 sizeof (GtkPrintCupsDispatchWatch));
593 dispatch->request = request;
594 dispatch->backend = g_object_ref (print_backend);
595 dispatch->data_poll = NULL;
597 g_source_set_callback ((GSource *) dispatch, (GSourceFunc) callback, user_data, notify);
599 g_source_attach ((GSource *) dispatch, NULL);
600 g_source_unref ((GSource *) dispatch);
604 cups_request_printer_info_cb (GtkPrintBackendCups *backend,
605 GtkCupsResult *result,
608 ipp_attribute_t *attr;
611 GtkPrinterCups *cups_printer;
617 gboolean status_changed;
619 g_assert (GTK_IS_PRINT_BACKEND_CUPS (backend));
621 printer_name = (gchar *)user_data;
622 printer = gtk_print_backend_find_printer (GTK_PRINT_BACKEND (backend),
628 cups_printer = GTK_PRINTER_CUPS (printer);
630 if (gtk_cups_result_is_error (result))
632 if (gtk_printer_is_new (printer))
634 gtk_print_backend_remove_printer (GTK_PRINT_BACKEND (backend),
639 return; /* TODO: mark as inactive printer */
642 response = gtk_cups_result_get_response (result);
644 /* TODO: determine printer type and use correct icon */
645 gtk_printer_set_icon_name (printer, "gtk-print");
651 for (attr = response->attrs; attr != NULL; attr = attr->next)
656 _CUPS_MAP_ATTR_STR (attr, loc, "printer-location");
657 _CUPS_MAP_ATTR_STR (attr, desc, "printer-info");
658 _CUPS_MAP_ATTR_STR (attr, state_msg, "printer-state-message");
659 _CUPS_MAP_ATTR_INT (attr, cups_printer->state, "printer-state");
660 _CUPS_MAP_ATTR_INT (attr, job_count, "queued-job-count");
663 status_changed = gtk_printer_set_job_count (printer, job_count);
665 status_changed |= gtk_printer_set_location (printer, loc);
666 status_changed |= gtk_printer_set_description (printer, desc);
667 status_changed |= gtk_printer_set_state_message (printer, state_msg);
670 g_signal_emit_by_name (GTK_PRINT_BACKEND (backend),
671 "printer-status-changed", printer);
675 cups_request_printer_info (GtkPrintBackendCups *print_backend,
676 const gchar *printer_name)
678 GtkCupsRequest *request;
680 static const char * const pattrs[] = /* Attributes we're interested in */
684 "printer-state-message",
689 request = gtk_cups_request_new (NULL,
691 IPP_GET_PRINTER_ATTRIBUTES,
696 printer_uri = g_strdup_printf ("ipp://localhost/printers/%s",
698 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION, IPP_TAG_URI,
699 "printer-uri", NULL, printer_uri);
701 g_free (printer_uri);
703 gtk_cups_request_ipp_add_strings (request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
704 "requested-attributes", G_N_ELEMENTS (pattrs),
707 cups_request_execute (print_backend,
709 (GtkPrintCupsResponseCallbackFunc) cups_request_printer_info_cb,
710 g_strdup (printer_name),
711 (GDestroyNotify) g_free);
716 GtkPrintBackendCups *print_backend;
723 job_object_died (gpointer user_data,
724 GObject *where_the_object_was)
726 CupsJobPollData *data = user_data;
731 cups_job_poll_data_free (CupsJobPollData *data)
734 g_object_weak_unref (G_OBJECT (data->job), job_object_died, data);
740 cups_request_job_info_cb (GtkPrintBackendCups *print_backend,
741 GtkCupsResult *result,
744 CupsJobPollData *data = user_data;
745 ipp_attribute_t *attr;
750 if (data->job == NULL)
752 cups_job_poll_data_free (data);
758 response = gtk_cups_result_get_response (result);
761 for (attr = response->attrs; attr != NULL; attr = attr->next)
766 _CUPS_MAP_ATTR_INT (attr, state, "job-state");
772 case IPP_JOB_PENDING:
774 case IPP_JOB_STOPPED:
775 gtk_print_job_set_status (data->job,
776 GTK_PRINT_STATUS_PENDING);
778 case IPP_JOB_PROCESSING:
779 gtk_print_job_set_status (data->job,
780 GTK_PRINT_STATUS_PRINTING);
783 case IPP_JOB_CANCELLED:
784 case IPP_JOB_ABORTED:
785 gtk_print_job_set_status (data->job,
786 GTK_PRINT_STATUS_FINISHED_ABORTED);
790 case IPP_JOB_COMPLETED:
791 gtk_print_job_set_status (data->job,
792 GTK_PRINT_STATUS_FINISHED);
797 if (!done && data->job != NULL)
801 if (data->counter < 5)
803 else if (data->counter < 10)
808 g_timeout_add (timeout, cups_job_info_poll_timeout, data);
811 cups_job_poll_data_free (data);
815 cups_request_job_info (CupsJobPollData *data)
817 GtkCupsRequest *request;
820 request = gtk_cups_request_new (NULL,
822 IPP_GET_JOB_ATTRIBUTES,
827 printer_uri = g_strdup_printf ("ipp://localhost/jobs/%d", data->job_id);
828 gtk_cups_request_ipp_add_string (request, IPP_TAG_OPERATION, IPP_TAG_URI,
829 "job-uri", NULL, printer_uri);
830 g_free (printer_uri);
832 cups_request_execute (data->print_backend,
834 (GtkPrintCupsResponseCallbackFunc) cups_request_job_info_cb,
840 cups_job_info_poll_timeout (gpointer user_data)
842 CupsJobPollData *data = user_data;
844 if (data->job == NULL)
845 cups_job_poll_data_free (data);
847 cups_request_job_info (data);
853 cups_begin_polling_info (GtkPrintBackendCups *print_backend,
857 CupsJobPollData *data;
859 data = g_new0 (CupsJobPollData, 1);
861 data->print_backend = print_backend;
863 data->job_id = job_id;
866 g_object_weak_ref (G_OBJECT (job), job_object_died, data);
868 cups_request_job_info (data);
872 mark_printer_inactive (GtkPrinter *printer,
873 GtkPrintBackend *backend)
875 gtk_printer_set_is_active (printer, FALSE);
876 g_signal_emit_by_name (backend, "printer-removed", printer);
880 find_printer (GtkPrinter *printer,
881 const gchar *find_name)
883 const gchar *printer_name;
885 printer_name = gtk_printer_get_name (printer);
886 return g_ascii_strcasecmp (printer_name, find_name);
890 cups_request_printer_list_cb (GtkPrintBackendCups *cups_backend,
891 GtkCupsResult *result,
894 GtkPrintBackend *backend = GTK_PRINT_BACKEND (cups_backend);
895 ipp_attribute_t *attr;
897 gboolean list_has_changed;
898 GList *removed_printer_checklist;
900 list_has_changed = FALSE;
902 cups_backend->list_printers_pending = FALSE;
904 if (gtk_cups_result_is_error (result))
906 g_warning ("Error getting printer list: %s", gtk_cups_result_get_error_string (result));
910 /* Gather the names of the printers in the current queue
911 * so we may check to see if they were removed
913 removed_printer_checklist = gtk_print_backend_get_printer_list (backend);
915 response = gtk_cups_result_get_response (result);
917 for (attr = response->attrs; attr != NULL; attr = attr->next)
920 const gchar *printer_name;
921 const gchar *printer_uri;
922 const gchar *member_uris;
925 /* Skip leading attributes until we hit a printer...
927 while (attr != NULL && attr->group_tag != IPP_TAG_PRINTER)
936 while (attr != NULL && attr->group_tag == IPP_TAG_PRINTER)
938 if (!strcmp (attr->name, "printer-name") &&
939 attr->value_tag == IPP_TAG_NAME)
940 printer_name = attr->values[0].string.text;
941 else if (!strcmp (attr->name, "printer-uri-supported") &&
942 attr->value_tag == IPP_TAG_URI)
943 printer_uri = attr->values[0].string.text;
944 else if (!strcmp (attr->name, "member-uris") &&
945 attr->value_tag == IPP_TAG_URI)
946 member_uris = attr->values[0].string.text;
951 if (printer_name == NULL ||
952 (printer_uri == NULL && member_uris == NULL))
960 /* remove name from checklist if it was found */
961 node = g_list_find_custom (removed_printer_checklist, printer_name, (GCompareFunc) find_printer);
962 removed_printer_checklist = g_list_delete_link (removed_printer_checklist, node);
964 printer = gtk_print_backend_find_printer (backend, printer_name);
967 GtkPrinterCups *cups_printer;
968 char uri[HTTP_MAX_URI]; /* Printer URI */
969 char method[HTTP_MAX_URI]; /* Method/scheme name */
970 char username[HTTP_MAX_URI]; /* Username:password */
971 char hostname[HTTP_MAX_URI]; /* Hostname */
972 char resource[HTTP_MAX_URI]; /* Resource name */
973 int port; /* Port number */
975 list_has_changed = TRUE;
976 cups_printer = gtk_printer_cups_new (printer_name, backend);
978 cups_printer->device_uri = g_strdup_printf ("/printers/%s", printer_name);
981 cups_printer->printer_uri = g_strdup (member_uris);
983 cups_printer->printer_uri = g_strdup (printer_uri);
985 #if (CUPS_VERSION_MAJOR == 1 && CUPS_VERSION_MINOR >= 2) || CUPS_VERSION_MAJOR > 1
986 httpSeparateURI (HTTP_URI_CODING_ALL, cups_printer->printer_uri,
987 method, sizeof (method),
988 username, sizeof (username),
989 hostname, sizeof (hostname),
991 resource, sizeof (resource));
994 httpSeparate (cups_printer->printer_uri,
1002 gethostname (uri, sizeof(uri));
1003 if (strcasecmp (uri, hostname) == 0)
1004 strcpy (hostname, "localhost");
1006 cups_printer->hostname = g_strdup (hostname);
1007 cups_printer->port = port;
1009 printer = GTK_PRINTER (cups_printer);
1011 if (cups_backend->default_printer != NULL &&
1012 strcmp (cups_backend->default_printer, gtk_printer_get_name (printer)) == 0)
1013 gtk_printer_set_is_default (printer, TRUE);
1016 gtk_print_backend_add_printer (backend, printer);
1019 g_object_ref (printer);
1021 if (!gtk_printer_is_active (printer))
1023 gtk_printer_set_is_active (printer, TRUE);
1024 gtk_printer_set_is_new (printer, TRUE);
1025 list_has_changed = TRUE;
1028 if (gtk_printer_is_new (printer))
1030 g_signal_emit_by_name (backend, "printer-added", printer);
1032 gtk_printer_set_is_new (printer, FALSE);
1035 cups_request_printer_info (cups_backend, gtk_printer_get_name (printer));
1037 /* The ref is held by GtkPrintBackend, in add_printer() */
1038 g_object_unref (printer);
1045 /* look at the removed printers checklist and mark any printer
1046 as inactive if it is in the list, emitting a printer_removed signal */
1047 if (removed_printer_checklist != NULL)
1049 g_list_foreach (removed_printer_checklist, (GFunc) mark_printer_inactive, backend);
1050 g_list_free (removed_printer_checklist);
1051 list_has_changed = TRUE;
1054 if (list_has_changed)
1055 g_signal_emit_by_name (backend, "printer-list-changed");
1057 gtk_print_backend_set_list_done (backend);
1061 cups_request_printer_list (GtkPrintBackendCups *cups_backend)
1063 GtkCupsRequest *request;
1064 static const char * const pattrs[] = /* Attributes we're interested in */
1067 "printer-uri-supported",
1071 if (cups_backend->list_printers_pending ||
1072 !cups_backend->got_default_printer)
1075 cups_backend->list_printers_pending = TRUE;
1077 request = gtk_cups_request_new (NULL,
1084 gtk_cups_request_ipp_add_strings (request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
1085 "requested-attributes", G_N_ELEMENTS (pattrs),
1088 cups_request_execute (cups_backend,
1090 (GtkPrintCupsResponseCallbackFunc) cups_request_printer_list_cb,
1098 cups_get_printer_list (GtkPrintBackend *backend)
1100 GtkPrintBackendCups *cups_backend;
1102 cups_backend = GTK_PRINT_BACKEND_CUPS (backend);
1103 if (cups_backend->list_printers_poll == 0)
1105 cups_request_printer_list (cups_backend);
1106 cups_backend->list_printers_poll = g_timeout_add (3000 * 100000,
1107 (GSourceFunc) cups_request_printer_list,
1113 GtkPrinterCups *printer;
1115 gchar *ppd_filename;
1119 get_ppd_data_free (GetPPDData *data)
1121 close (data->ppd_fd);
1122 unlink (data->ppd_filename);
1123 g_free (data->ppd_filename);
1124 g_object_unref (data->printer);
1129 cups_request_ppd_cb (GtkPrintBackendCups *print_backend,
1130 GtkCupsResult *result,
1134 GtkPrinter *printer;
1136 printer = GTK_PRINTER (data->printer);
1137 GTK_PRINTER_CUPS (printer)->reading_ppd = FALSE;
1139 if (gtk_cups_result_is_error (result))
1141 g_signal_emit_by_name (printer, "details-acquired", printer, FALSE);
1145 response = gtk_cups_result_get_response (result);
1147 data->printer->ppd_file = ppdOpenFile (data->ppd_filename);
1148 gtk_printer_set_has_details (printer, TRUE);
1149 g_signal_emit_by_name (printer, "details-acquired", printer, TRUE);
1153 cups_request_ppd (GtkPrinter *printer)
1156 GtkPrintBackend *print_backend;
1157 GtkPrinterCups *cups_printer;
1158 GtkCupsRequest *request;
1163 cups_printer = GTK_PRINTER_CUPS (printer);
1166 /* FIXME this can return NULL! */
1167 http = httpConnectEncrypt (cups_printer->hostname,
1171 data = g_new0 (GetPPDData, 1);
1173 data->ppd_fd = g_file_open_tmp ("gtkprint_ppd_XXXXXX",
1174 &data->ppd_filename,
1179 g_warning ("%s", error->message);
1180 g_error_free (error);
1184 g_signal_emit_by_name (printer, "details-acquired", printer, FALSE);
1188 fchmod (data->ppd_fd, S_IRUSR | S_IWUSR);
1190 data->printer = g_object_ref (printer);
1192 resource = g_strdup_printf ("/printers/%s.ppd", gtk_printer_get_name (printer));
1193 request = gtk_cups_request_new (http,
1197 cups_printer->hostname,
1202 cups_printer->reading_ppd = TRUE;
1204 print_backend = gtk_printer_get_backend (printer);
1206 cups_request_execute (GTK_PRINT_BACKEND_CUPS (print_backend),
1208 (GtkPrintCupsResponseCallbackFunc) cups_request_ppd_cb,
1210 (GDestroyNotify)get_ppd_data_free);
1215 cups_request_default_printer_cb (GtkPrintBackendCups *print_backend,
1216 GtkCupsResult *result,
1220 ipp_attribute_t *attr;
1222 response = gtk_cups_result_get_response (result);
1224 if ((attr = ippFindAttribute (response, "printer-name", IPP_TAG_NAME)) != NULL)
1225 print_backend->default_printer = g_strdup (attr->values[0].string.text);
1227 print_backend->got_default_printer = TRUE;
1229 /* Make sure to kick off get_printers if we are polling it,
1230 * as we could have blocked this reading the default printer
1232 if (print_backend->list_printers_poll != 0)
1233 cups_request_printer_list (print_backend);
1237 cups_request_default_printer (GtkPrintBackendCups *print_backend)
1239 GtkCupsRequest *request;
1242 if ((str = g_getenv ("LPDEST")) != NULL)
1244 print_backend->default_printer = g_strdup (str);
1245 print_backend->got_default_printer = TRUE;
1248 else if ((str = g_getenv ("PRINTER")) != NULL &&
1249 strcmp (str, "lp") != 0)
1251 print_backend->default_printer = g_strdup (str);
1252 print_backend->got_default_printer = TRUE;
1256 request = gtk_cups_request_new (NULL,
1263 cups_request_execute (print_backend,
1265 (GtkPrintCupsResponseCallbackFunc) cups_request_default_printer_cb,
1266 g_object_ref (print_backend),
1271 cups_printer_request_details (GtkPrinter *printer)
1273 GtkPrinterCups *cups_printer;
1275 cups_printer = GTK_PRINTER_CUPS (printer);
1276 if (!cups_printer->reading_ppd &&
1277 gtk_printer_cups_get_ppd (cups_printer) == NULL)
1278 cups_request_ppd (printer);
1282 ppd_text_to_utf8 (ppd_file_t *ppd_file,
1285 const char *encoding = NULL;
1288 if (g_ascii_strcasecmp (ppd_file->lang_encoding, "UTF-8") == 0)
1290 return g_strdup (text);
1292 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "ISOLatin1") == 0)
1294 encoding = "ISO-8859-1";
1296 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "ISOLatin2") == 0)
1298 encoding = "ISO-8859-2";
1300 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "ISOLatin5") == 0)
1302 encoding = "ISO-8859-5";
1304 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "JIS83-RKSJ") == 0)
1306 encoding = "SHIFT-JIS";
1308 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "MacStandard") == 0)
1310 encoding = "MACINTOSH";
1312 else if (g_ascii_strcasecmp (ppd_file->lang_encoding, "WindowsANSI") == 0)
1314 encoding = "WINDOWS-1252";
1318 /* Fallback, try iso-8859-1... */
1319 encoding = "ISO-8859-1";
1322 res = g_convert (text, -1, "UTF-8", encoding, NULL, NULL, NULL);
1326 g_warning ("unable to convert PPD text");
1327 res = g_strdup ("???");
1333 /* TODO: Add more translations for common settings here */
1335 static const struct {
1336 const char *keyword;
1337 const char *translation;
1338 } cups_option_translations[] = {
1339 { "Duplex", N_("Two Sided") },
1340 { "MediaType", N_("Paper Type") },
1341 { "InputSlot", N_("Paper Source") },
1342 { "OutputBin", N_("Output Tray") },
1346 static const struct {
1347 const char *keyword;
1349 const char *translation;
1350 } cups_choice_translations[] = {
1351 { "Duplex", "None", N_("One Sided") },
1352 { "InputSlot", "Auto", N_("Auto Select") },
1353 { "InputSlot", "AutoSelect", N_("Auto Select") },
1354 { "InputSlot", "Default", N_("Printer Default") },
1355 { "InputSlot", "None", N_("Printer Default") },
1356 { "InputSlot", "PrinterDefault", N_("Printer Default") },
1357 { "InputSlot", "Unspecified", N_("Auto Select") },
1360 static const struct {
1361 const char *ppd_keyword;
1363 } option_names[] = {
1364 {"Duplex", "gtk-duplex" },
1365 {"MediaType", "gtk-paper-type"},
1366 {"InputSlot", "gtk-paper-source"},
1367 {"OutputBin", "gtk-output-tray"},
1370 /* keep sorted when changing */
1371 static const char *color_option_whitelist[] = {
1372 "BRColorEnhancement",
1378 "BlackSubstitution",
1386 "RPSBlackOverPrint",
1390 /* keep sorted when changing */
1391 static const char *color_group_whitelist[] = {
1398 "HPColorOptionsPanel",
1401 /* keep sorted when changing */
1402 static const char *image_quality_option_whitelist[] = {
1404 "BRHalfTonePattern",
1414 "HPGraphicsHalftone",
1429 /* keep sorted when changing */
1430 static const char *image_quality_group_whitelist[] = {
1437 /* keep sorted when changing */
1438 static const char * finishing_option_whitelist[] = {
1451 "StapleOrientation",
1457 /* keep sorted when changing */
1458 static const char *finishing_group_whitelist[] = {
1467 /* keep sorted when changing */
1468 static const char *cups_option_blacklist[] = {
1477 get_option_text (ppd_file_t *ppd_file,
1478 ppd_option_t *option)
1483 for (i = 0; i < G_N_ELEMENTS (cups_option_translations); i++)
1485 if (strcmp (cups_option_translations[i].keyword, option->keyword) == 0)
1486 return g_strdup (_(cups_option_translations[i].translation));
1489 utf8 = ppd_text_to_utf8 (ppd_file, option->text);
1491 /* Some ppd files have spaces in the text before the colon */
1498 get_choice_text (ppd_file_t *ppd_file,
1499 ppd_choice_t *choice)
1502 ppd_option_t *option = choice->option;
1503 const char *keyword = option->keyword;
1505 for (i = 0; i < G_N_ELEMENTS (cups_choice_translations); i++)
1507 if (strcmp (cups_choice_translations[i].keyword, keyword) == 0 &&
1508 strcmp (cups_choice_translations[i].choice, choice->choice) == 0)
1509 return g_strdup (_(cups_choice_translations[i].translation));
1511 return ppd_text_to_utf8 (ppd_file, choice->text);
1515 group_has_option (ppd_group_t *group,
1516 ppd_option_t *option)
1523 if (group->num_options > 0 &&
1524 option >= group->options && option < group->options + group->num_options)
1527 for (i = 0; i < group->num_subgroups; i++)
1529 if (group_has_option (&group->subgroups[i],option))
1536 set_option_off (GtkPrinterOption *option)
1538 /* Any of these will do, _set only applies the value
1539 * if its allowed of the option */
1540 gtk_printer_option_set (option, "False");
1541 gtk_printer_option_set (option, "Off");
1542 gtk_printer_option_set (option, "None");
1546 value_is_off (const char *value)
1548 return (strcasecmp (value, "None") == 0 ||
1549 strcasecmp (value, "Off") == 0 ||
1550 strcasecmp (value, "False") == 0);
1554 available_choices (ppd_file_t *ppd,
1555 ppd_option_t *option,
1556 ppd_choice_t ***available,
1557 gboolean keep_if_only_one_option)
1559 ppd_option_t *other_option;
1562 ppd_const_t *constraint;
1563 const char *choice, *other_choice;
1564 ppd_option_t *option1, *option2;
1565 ppd_group_t *installed_options;
1567 gboolean all_default;
1573 conflicts = g_new0 (char, option->num_choices);
1575 installed_options = NULL;
1576 for (i = 0; i < ppd->num_groups; i++)
1578 if (strcmp (ppd->groups[i].name, "InstallableOptions") == 0)
1580 installed_options = &ppd->groups[i];
1585 for (i = ppd->num_consts, constraint = ppd->consts; i > 0; i--, constraint++)
1587 option1 = ppdFindOption (ppd, constraint->option1);
1588 if (option1 == NULL)
1591 option2 = ppdFindOption (ppd, constraint->option2);
1592 if (option2 == NULL)
1595 if (option == option1)
1597 choice = constraint->choice1;
1598 other_option = option2;
1599 other_choice = constraint->choice2;
1601 else if (option == option2)
1603 choice = constraint->choice2;
1604 other_option = option1;
1605 other_choice = constraint->choice1;
1610 /* We only care of conflicts with installed_options and
1612 if (!group_has_option (installed_options, other_option) &&
1613 (strcmp (other_option->keyword, "PageSize") != 0))
1616 if (*other_choice == 0)
1618 /* Conflict only if the installed option is not off */
1619 if (value_is_off (other_option->defchoice))
1622 /* Conflict if the installed option has the specified default */
1623 else if (strcasecmp (other_choice, other_option->defchoice) != 0)
1628 /* Conflict with all non-off choices */
1629 for (j = 0; j < option->num_choices; j++)
1631 if (!value_is_off (option->choices[j].choice))
1637 for (j = 0; j < option->num_choices; j++)
1639 if (strcasecmp (option->choices[j].choice, choice) == 0)
1647 for (j = 0; j < option->num_choices; j++)
1651 else if (strcmp (option->choices[j].choice, option->defchoice) != 0)
1652 all_default = FALSE;
1655 if (all_default && !keep_if_only_one_option)
1658 if (num_conflicts == option->num_choices)
1662 /* Some ppds don't have a "use printer default" option for
1663 * InputSlot. This means you always have to select a particular slot,
1664 * and you can't auto-pick source based on the paper size. To support
1665 * this we always add an auto option if there isn't one already. If
1666 * the user chooses the generated option we don't send any InputSlot
1667 * value when printing. The way we detect existing auto-cases is based
1668 * on feedback from Michael Sweet of cups fame.
1671 if (strcmp (option->keyword, "InputSlot") == 0)
1673 gboolean found_auto = FALSE;
1674 for (j = 0; j < option->num_choices; j++)
1678 if (strcmp (option->choices[j].choice, "Auto") == 0 ||
1679 strcmp (option->choices[j].choice, "AutoSelect") == 0 ||
1680 strcmp (option->choices[j].choice, "Default") == 0 ||
1681 strcmp (option->choices[j].choice, "None") == 0 ||
1682 strcmp (option->choices[j].choice, "PrinterDefault") == 0 ||
1683 strcmp (option->choices[j].choice, "Unspecified") == 0 ||
1684 option->choices[j].code == NULL ||
1685 option->choices[j].code[0] == 0)
1700 *available = g_new (ppd_choice_t *, option->num_choices - num_conflicts + add_auto);
1703 for (j = 0; j < option->num_choices; j++)
1706 (*available)[i++] = &option->choices[j];
1710 (*available)[i++] = NULL;
1713 return option->num_choices - num_conflicts + add_auto;
1716 static GtkPrinterOption *
1717 create_pickone_option (ppd_file_t *ppd_file,
1718 ppd_option_t *ppd_option,
1719 const gchar *gtk_name)
1721 GtkPrinterOption *option;
1722 ppd_choice_t **available;
1727 g_assert (ppd_option->ui == PPD_UI_PICKONE);
1731 n_choices = available_choices (ppd_file, ppd_option, &available, g_str_has_prefix (gtk_name, "gtk-"));
1734 label = get_option_text (ppd_file, ppd_option);
1735 option = gtk_printer_option_new (gtk_name, label,
1736 GTK_PRINTER_OPTION_TYPE_PICKONE);
1739 gtk_printer_option_allocate_choices (option, n_choices);
1740 for (i = 0; i < n_choices; i++)
1742 if (available[i] == NULL)
1744 /* This was auto-added */
1745 option->choices[i] = g_strdup ("gtk-ignore-value");
1746 option->choices_display[i] = g_strdup (_("Printer Default"));
1750 option->choices[i] = g_strdup (available[i]->choice);
1751 option->choices_display[i] = get_choice_text (ppd_file, available[i]);
1754 gtk_printer_option_set (option, ppd_option->defchoice);
1756 #ifdef PRINT_IGNORED_OPTIONS
1758 g_warning ("Ignoring pickone %s\n", ppd_option->text);
1765 static GtkPrinterOption *
1766 create_boolean_option (ppd_file_t *ppd_file,
1767 ppd_option_t *ppd_option,
1768 const gchar *gtk_name)
1770 GtkPrinterOption *option;
1771 ppd_choice_t **available;
1775 g_assert (ppd_option->ui == PPD_UI_BOOLEAN);
1779 n_choices = available_choices (ppd_file, ppd_option, &available, g_str_has_prefix (gtk_name, "gtk-"));
1782 label = get_option_text (ppd_file, ppd_option);
1783 option = gtk_printer_option_new (gtk_name, label,
1784 GTK_PRINTER_OPTION_TYPE_BOOLEAN);
1787 gtk_printer_option_allocate_choices (option, 2);
1788 option->choices[0] = g_strdup ("True");
1789 option->choices_display[0] = g_strdup ("True");
1790 option->choices[1] = g_strdup ("False");
1791 option->choices_display[1] = g_strdup ("False");
1793 gtk_printer_option_set (option, ppd_option->defchoice);
1795 #ifdef PRINT_IGNORED_OPTIONS
1797 g_warning ("Ignoring boolean %s\n", ppd_option->text);
1805 get_option_name (const gchar *keyword)
1809 for (i = 0; i < G_N_ELEMENTS (option_names); i++)
1810 if (strcmp (option_names[i].ppd_keyword, keyword) == 0)
1811 return g_strdup (option_names[i].name);
1813 return g_strdup_printf ("cups-%s", keyword);
1817 strptr_cmp (const void *a,
1820 char **aa = (char **)a;
1821 char **bb = (char **)b;
1822 return strcmp (*aa, *bb);
1827 string_in_table (gchar *str,
1828 const gchar *table[],
1831 return bsearch (&str, table, table_len, sizeof (char *), (void *)strptr_cmp) != NULL;
1834 #define STRING_IN_TABLE(_str, _table) (string_in_table (_str, _table, G_N_ELEMENTS (_table)))
1837 handle_option (GtkPrinterOptionSet *set,
1838 ppd_file_t *ppd_file,
1839 ppd_option_t *ppd_option,
1840 ppd_group_t *toplevel_group,
1841 GtkPrintSettings *settings)
1843 GtkPrinterOption *option;
1846 if (STRING_IN_TABLE (ppd_option->keyword, cups_option_blacklist))
1849 name = get_option_name (ppd_option->keyword);
1852 if (ppd_option->ui == PPD_UI_PICKONE)
1854 option = create_pickone_option (ppd_file, ppd_option, name);
1856 else if (ppd_option->ui == PPD_UI_BOOLEAN)
1858 option = create_boolean_option (ppd_file, ppd_option, name);
1861 g_warning ("Ignored pickmany setting %s\n", ppd_option->text);
1866 if (STRING_IN_TABLE (toplevel_group->name,
1867 color_group_whitelist) ||
1868 STRING_IN_TABLE (ppd_option->keyword,
1869 color_option_whitelist))
1871 option->group = g_strdup ("ColorPage");
1873 else if (STRING_IN_TABLE (toplevel_group->name,
1874 image_quality_group_whitelist) ||
1875 STRING_IN_TABLE (ppd_option->keyword,
1876 image_quality_option_whitelist))
1878 option->group = g_strdup ("ImageQualityPage");
1880 else if (STRING_IN_TABLE (toplevel_group->name,
1881 finishing_group_whitelist) ||
1882 STRING_IN_TABLE (ppd_option->keyword,
1883 finishing_option_whitelist))
1885 option->group = g_strdup ("FinishingPage");
1889 option->group = g_strdup (toplevel_group->text);
1892 set_option_from_settings (option, settings);
1894 gtk_printer_option_set_add (set, option);
1901 handle_group (GtkPrinterOptionSet *set,
1902 ppd_file_t *ppd_file,
1904 ppd_group_t *toplevel_group,
1905 GtkPrintSettings *settings)
1909 /* Ignore installable options */
1910 if (strcmp (toplevel_group->name, "InstallableOptions") == 0)
1913 for (i = 0; i < group->num_options; i++)
1914 handle_option (set, ppd_file, &group->options[i], toplevel_group, settings);
1916 for (i = 0; i < group->num_subgroups; i++)
1917 handle_group (set, ppd_file, &group->subgroups[i], toplevel_group, settings);
1921 static GtkPrinterOptionSet *
1922 cups_printer_get_options (GtkPrinter *printer,
1923 GtkPrintSettings *settings,
1924 GtkPageSetup *page_setup)
1926 GtkPrinterOptionSet *set;
1927 GtkPrinterOption *option;
1928 ppd_file_t *ppd_file;
1930 char *print_at[] = { "now", "at", "on-hold" };
1931 char *n_up[] = {"1", "2", "4", "6", "9", "16" };
1932 char *prio[] = {"100", "80", "50", "30" };
1933 char *prio_display[] = {N_("Urgent"), N_("High"), N_("Medium"), N_("Low") };
1934 char *cover[] = {"none", "classified", "confidential", "secret", "standard", "topsecret", "unclassified" };
1935 char *cover_display[] = {N_("None"), N_("Classified"), N_("Confidential"), N_("Secret"), N_("Standard"), N_("Top Secret"), N_("Unclassified"),};
1938 set = gtk_printer_option_set_new ();
1940 /* Cups specific, non-ppd related settings */
1942 option = gtk_printer_option_new ("gtk-n-up", "Pages Per Sheet", GTK_PRINTER_OPTION_TYPE_PICKONE);
1943 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (n_up),
1945 gtk_printer_option_set (option, "1");
1946 set_option_from_settings (option, settings);
1947 gtk_printer_option_set_add (set, option);
1948 g_object_unref (option);
1950 for (i = 0; i < G_N_ELEMENTS(prio_display); i++)
1951 prio_display[i] = _(prio_display[i]);
1953 option = gtk_printer_option_new ("gtk-job-prio", "Job Priority", GTK_PRINTER_OPTION_TYPE_PICKONE);
1954 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (prio),
1955 prio, prio_display);
1956 gtk_printer_option_set (option, "50");
1957 set_option_from_settings (option, settings);
1958 gtk_printer_option_set_add (set, option);
1959 g_object_unref (option);
1961 option = gtk_printer_option_new ("gtk-billing-info", "Billing Info", GTK_PRINTER_OPTION_TYPE_STRING);
1962 gtk_printer_option_set (option, "");
1963 set_option_from_settings (option, settings);
1964 gtk_printer_option_set_add (set, option);
1965 g_object_unref (option);
1967 for (i = 0; i < G_N_ELEMENTS(cover_display); i++)
1968 cover_display[i] = _(cover_display[i]);
1970 option = gtk_printer_option_new ("gtk-cover-before", "Before", GTK_PRINTER_OPTION_TYPE_PICKONE);
1971 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (cover),
1972 cover, cover_display);
1973 gtk_printer_option_set (option, "none");
1974 set_option_from_settings (option, settings);
1975 gtk_printer_option_set_add (set, option);
1976 g_object_unref (option);
1978 option = gtk_printer_option_new ("gtk-cover-after", "After", GTK_PRINTER_OPTION_TYPE_PICKONE);
1979 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (cover),
1980 cover, cover_display);
1981 gtk_printer_option_set (option, "none");
1982 set_option_from_settings (option, settings);
1983 gtk_printer_option_set_add (set, option);
1984 g_object_unref (option);
1986 option = gtk_printer_option_new ("gtk-print-time", "Print at", GTK_PRINTER_OPTION_TYPE_PICKONE);
1987 gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (print_at),
1988 print_at, print_at);
1989 gtk_printer_option_set (option, "now");
1990 set_option_from_settings (option, settings);
1991 gtk_printer_option_set_add (set, option);
1992 g_object_unref (option);
1994 option = gtk_printer_option_new ("gtk-print-time-text", "Print at time", GTK_PRINTER_OPTION_TYPE_STRING);
1995 gtk_printer_option_set (option, "");
1996 set_option_from_settings (option, settings);
1997 gtk_printer_option_set_add (set, option);
1998 g_object_unref (option);
2000 /* Printer (ppd) specific settings */
2001 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
2004 GtkPaperSize *paper_size;
2005 ppd_option_t *option;
2007 ppdMarkDefaults (ppd_file);
2009 paper_size = gtk_page_setup_get_paper_size (page_setup);
2011 option = ppdFindOption (ppd_file, "PageSize");
2012 strncpy (option->defchoice, gtk_paper_size_get_ppd_name (paper_size),
2015 for (i = 0; i < ppd_file->num_groups; i++)
2016 handle_group (set, ppd_file, &ppd_file->groups[i], &ppd_file->groups[i], settings);
2024 mark_option_from_set (GtkPrinterOptionSet *set,
2025 ppd_file_t *ppd_file,
2026 ppd_option_t *ppd_option)
2028 GtkPrinterOption *option;
2029 char *name = get_option_name (ppd_option->keyword);
2031 option = gtk_printer_option_set_lookup (set, name);
2034 ppdMarkOption (ppd_file, ppd_option->keyword, option->value);
2041 mark_group_from_set (GtkPrinterOptionSet *set,
2042 ppd_file_t *ppd_file,
2047 for (i = 0; i < group->num_options; i++)
2048 mark_option_from_set (set, ppd_file, &group->options[i]);
2050 for (i = 0; i < group->num_subgroups; i++)
2051 mark_group_from_set (set, ppd_file, &group->subgroups[i]);
2055 set_conflicts_from_option (GtkPrinterOptionSet *set,
2056 ppd_file_t *ppd_file,
2057 ppd_option_t *ppd_option)
2059 GtkPrinterOption *option;
2062 if (ppd_option->conflicted)
2064 name = get_option_name (ppd_option->keyword);
2065 option = gtk_printer_option_set_lookup (set, name);
2068 gtk_printer_option_set_has_conflict (option, TRUE);
2070 g_warning ("conflict for option %s ignored", ppd_option->keyword);
2077 set_conflicts_from_group (GtkPrinterOptionSet *set,
2078 ppd_file_t *ppd_file,
2083 for (i = 0; i < group->num_options; i++)
2084 set_conflicts_from_option (set, ppd_file, &group->options[i]);
2086 for (i = 0; i < group->num_subgroups; i++)
2087 set_conflicts_from_group (set, ppd_file, &group->subgroups[i]);
2091 cups_printer_mark_conflicts (GtkPrinter *printer,
2092 GtkPrinterOptionSet *options)
2094 ppd_file_t *ppd_file;
2098 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
2100 if (ppd_file == NULL)
2103 ppdMarkDefaults (ppd_file);
2105 for (i = 0; i < ppd_file->num_groups; i++)
2106 mark_group_from_set (options, ppd_file, &ppd_file->groups[i]);
2108 num_conflicts = ppdConflicts (ppd_file);
2110 if (num_conflicts > 0)
2112 for (i = 0; i < ppd_file->num_groups; i++)
2113 set_conflicts_from_group (options, ppd_file, &ppd_file->groups[i]);
2116 return num_conflicts > 0;
2120 GtkPrinter *printer;
2121 GtkPrinterOptionSet *options;
2122 GtkPrintSettings *settings;
2123 ppd_file_t *ppd_file;
2128 const char *standard;
2132 map_settings_to_option (GtkPrinterOption *option,
2133 const NameMapping table[],
2135 GtkPrintSettings *settings,
2136 const gchar *standard_name,
2137 const gchar *cups_name)
2141 const char *cups_value;
2142 const char *standard_value;
2144 /* If the cups-specific setting is set, always use that */
2145 name = g_strdup_printf ("cups-%s", cups_name);
2146 cups_value = gtk_print_settings_get (settings, name);
2149 if (cups_value != NULL)
2151 gtk_printer_option_set (option, cups_value);
2155 /* Otherwise we try to convert from the general setting */
2156 standard_value = gtk_print_settings_get (settings, standard_name);
2157 if (standard_value == NULL)
2160 for (i = 0; i < n_elements; i++)
2162 if (table[i].cups == NULL && table[i].standard == NULL)
2164 gtk_printer_option_set (option, standard_value);
2167 else if (table[i].cups == NULL &&
2168 strcmp (table[i].standard, standard_value) == 0)
2170 set_option_off (option);
2173 else if (strcmp (table[i].standard, standard_value) == 0)
2175 gtk_printer_option_set (option, table[i].cups);
2182 map_option_to_settings (const gchar *value,
2183 const NameMapping table[],
2185 GtkPrintSettings *settings,
2186 const gchar *standard_name,
2187 const gchar *cups_name)
2192 for (i = 0; i < n_elements; i++)
2194 if (table[i].cups == NULL && table[i].standard == NULL)
2196 gtk_print_settings_set (settings,
2201 else if (table[i].cups == NULL && table[i].standard != NULL)
2203 if (value_is_off (value))
2205 gtk_print_settings_set (settings,
2211 else if (strcmp (table[i].cups, value) == 0)
2213 gtk_print_settings_set (settings,
2220 /* Always set the corresponding cups-specific setting */
2221 name = g_strdup_printf ("cups-%s", cups_name);
2222 gtk_print_settings_set (settings, name, value);
2227 static const NameMapping paper_source_map[] = {
2228 { "Lower", "lower"},
2229 { "Middle", "middle"},
2230 { "Upper", "upper"},
2232 { "Envelope", "envelope"},
2233 { "Cassette", "cassette"},
2234 { "LargeCapacity", "large-capacity"},
2235 { "AnySmallFormat", "small-format"},
2236 { "AnyLargeFormat", "large-format"},
2240 static const NameMapping output_tray_map[] = {
2241 { "Upper", "upper"},
2242 { "Lower", "lower"},
2247 static const NameMapping duplex_map[] = {
2248 { "DuplexTumble", "vertical" },
2249 { "DuplexNoTumble", "horizontal" },
2253 static const NameMapping output_mode_map[] = {
2254 { "Standard", "normal" },
2255 { "Normal", "normal" },
2256 { "Draft", "draft" },
2257 { "Fast", "draft" },
2260 static const NameMapping media_type_map[] = {
2261 { "Transparency", "transparency"},
2262 { "Standard", "stationery"},
2266 static const NameMapping all_map[] = {
2272 set_option_from_settings (GtkPrinterOption *option,
2273 GtkPrintSettings *settings)
2275 const char *cups_value;
2278 if (settings == NULL)
2281 if (strcmp (option->name, "gtk-paper-source") == 0)
2282 map_settings_to_option (option, paper_source_map, G_N_ELEMENTS (paper_source_map),
2283 settings, GTK_PRINT_SETTINGS_DEFAULT_SOURCE, "InputSlot");
2284 else if (strcmp (option->name, "gtk-output-tray") == 0)
2285 map_settings_to_option (option, output_tray_map, G_N_ELEMENTS (output_tray_map),
2286 settings, GTK_PRINT_SETTINGS_OUTPUT_BIN, "OutputBin");
2287 else if (strcmp (option->name, "gtk-duplex") == 0)
2288 map_settings_to_option (option, duplex_map, G_N_ELEMENTS (duplex_map),
2289 settings, GTK_PRINT_SETTINGS_DUPLEX, "Duplex");
2290 else if (strcmp (option->name, "cups-OutputMode") == 0)
2291 map_settings_to_option (option, output_mode_map, G_N_ELEMENTS (output_mode_map),
2292 settings, GTK_PRINT_SETTINGS_QUALITY, "OutputMode");
2293 else if (strcmp (option->name, "cups-Resolution") == 0)
2295 cups_value = gtk_print_settings_get (settings, option->name);
2297 gtk_printer_option_set (option, cups_value);
2300 int res = gtk_print_settings_get_resolution (settings);
2303 value = g_strdup_printf ("%ddpi", res);
2304 gtk_printer_option_set (option, value);
2309 else if (strcmp (option->name, "gtk-paper-type") == 0)
2310 map_settings_to_option (option, media_type_map, G_N_ELEMENTS (media_type_map),
2311 settings, GTK_PRINT_SETTINGS_MEDIA_TYPE, "MediaType");
2312 else if (strcmp (option->name, "gtk-n-up") == 0)
2314 map_settings_to_option (option, all_map, G_N_ELEMENTS (all_map),
2315 settings, GTK_PRINT_SETTINGS_NUMBER_UP, "number-up");
2317 else if (strcmp (option->name, "gtk-billing-info") == 0)
2319 cups_value = gtk_print_settings_get (settings, "cups-job-billing");
2321 gtk_printer_option_set (option, cups_value);
2323 else if (strcmp (option->name, "gtk-job-prio") == 0)
2325 cups_value = gtk_print_settings_get (settings, "cups-job-priority");
2327 gtk_printer_option_set (option, cups_value);
2329 else if (strcmp (option->name, "gtk-cover-before") == 0)
2331 cups_value = gtk_print_settings_get (settings, "cover-before");
2333 gtk_printer_option_set (option, cups_value);
2335 else if (strcmp (option->name, "gtk-cover-after") == 0)
2337 cups_value = gtk_print_settings_get (settings, "cover-after");
2339 gtk_printer_option_set (option, cups_value);
2341 else if (strcmp (option->name, "gtk-print-time") == 0)
2343 cups_value = gtk_print_settings_get (settings, "print-at");
2345 gtk_printer_option_set (option, cups_value);
2347 else if (strcmp (option->name, "gtk-print-time-text") == 0)
2349 cups_value = gtk_print_settings_get (settings, "print-at-time");
2351 gtk_printer_option_set (option, cups_value);
2353 else if (g_str_has_prefix (option->name, "cups-"))
2355 cups_value = gtk_print_settings_get (settings, option->name);
2357 gtk_printer_option_set (option, cups_value);
2362 foreach_option_get_settings (GtkPrinterOption *option,
2365 struct OptionData *data = user_data;
2366 GtkPrintSettings *settings = data->settings;
2369 value = option->value;
2371 if (strcmp (option->name, "gtk-paper-source") == 0)
2372 map_option_to_settings (value, paper_source_map, G_N_ELEMENTS (paper_source_map),
2373 settings, GTK_PRINT_SETTINGS_DEFAULT_SOURCE, "InputSlot");
2374 else if (strcmp (option->name, "gtk-output-tray") == 0)
2375 map_option_to_settings (value, output_tray_map, G_N_ELEMENTS (output_tray_map),
2376 settings, GTK_PRINT_SETTINGS_OUTPUT_BIN, "OutputBin");
2377 else if (strcmp (option->name, "gtk-duplex") == 0)
2378 map_option_to_settings (value, duplex_map, G_N_ELEMENTS (duplex_map),
2379 settings, GTK_PRINT_SETTINGS_DUPLEX, "Duplex");
2380 else if (strcmp (option->name, "cups-OutputMode") == 0)
2381 map_option_to_settings (value, output_mode_map, G_N_ELEMENTS (output_mode_map),
2382 settings, GTK_PRINT_SETTINGS_QUALITY, "OutputMode");
2383 else if (strcmp (option->name, "cups-Resolution") == 0)
2385 int res = atoi (value);
2386 /* TODO: What if resolution is on XXXxYYYdpi form? */
2388 gtk_print_settings_set_resolution (settings, res);
2389 gtk_print_settings_set (settings, option->name, value);
2391 else if (strcmp (option->name, "gtk-paper-type") == 0)
2392 map_option_to_settings (value, media_type_map, G_N_ELEMENTS (media_type_map),
2393 settings, GTK_PRINT_SETTINGS_MEDIA_TYPE, "MediaType");
2394 else if (strcmp (option->name, "gtk-n-up") == 0)
2395 map_option_to_settings (value, all_map, G_N_ELEMENTS (all_map),
2396 settings, GTK_PRINT_SETTINGS_NUMBER_UP, "number-up");
2397 else if (strcmp (option->name, "gtk-billing-info") == 0 && strlen (value) > 0)
2398 gtk_print_settings_set (settings, "cups-job-billing", value);
2399 else if (strcmp (option->name, "gtk-job-prio") == 0)
2400 gtk_print_settings_set (settings, "cups-job-priority", value);
2401 else if (strcmp (option->name, "gtk-cover-before") == 0)
2402 gtk_print_settings_set (settings, "cover-before", value);
2403 else if (strcmp (option->name, "gtk-cover-after") == 0)
2404 gtk_print_settings_set (settings, "cover-after", value);
2405 else if (strcmp (option->name, "gtk-print-time") == 0)
2406 gtk_print_settings_set (settings, "print-at", value);
2407 else if (strcmp (option->name, "gtk-print-time-text") == 0)
2408 gtk_print_settings_set (settings, "print-at-time", value);
2409 else if (g_str_has_prefix (option->name, "cups-"))
2410 gtk_print_settings_set (settings, option->name, value);
2414 cups_printer_get_settings_from_options (GtkPrinter *printer,
2415 GtkPrinterOptionSet *options,
2416 GtkPrintSettings *settings)
2418 struct OptionData data;
2419 const char *print_at, *print_at_time;
2421 data.printer = printer;
2422 data.options = options;
2423 data.settings = settings;
2424 data.ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
2426 if (data.ppd_file != NULL)
2428 GtkPrinterOption *cover_before, *cover_after;
2430 gtk_printer_option_set_foreach (options, foreach_option_get_settings, &data);
2432 cover_before = gtk_printer_option_set_lookup (options, "gtk-cover-before");
2433 cover_after = gtk_printer_option_set_lookup (options, "gtk-cover-after");
2434 if (cover_before && cover_after)
2436 char *value = g_strdup_printf ("%s,%s", cover_before->value, cover_after->value);
2437 gtk_print_settings_set (settings, "cups-job-sheets", value);
2441 print_at = gtk_print_settings_get (settings, "print-at");
2442 print_at_time = gtk_print_settings_get (settings, "print-at-time");
2443 if (strcmp (print_at, "at") == 0)
2444 gtk_print_settings_set (settings, "cups-job-hold-until", print_at_time);
2445 else if (strcmp (print_at, "on-hold") == 0)
2446 gtk_print_settings_set (settings, "cups-job-hold-until", "indefinite");
2451 cups_printer_prepare_for_print (GtkPrinter *printer,
2452 GtkPrintJob *print_job,
2453 GtkPrintSettings *settings,
2454 GtkPageSetup *page_setup)
2456 GtkPageSet page_set;
2457 GtkPaperSize *paper_size;
2458 const char *ppd_paper_name;
2461 print_job->print_pages = gtk_print_settings_get_print_pages (settings);
2462 print_job->page_ranges = NULL;
2463 print_job->num_page_ranges = 0;
2465 if (print_job->print_pages == GTK_PRINT_PAGES_RANGES)
2466 print_job->page_ranges =
2467 gtk_print_settings_get_page_ranges (settings,
2468 &print_job->num_page_ranges);
2470 if (gtk_print_settings_get_collate (settings))
2471 gtk_print_settings_set (settings, "cups-Collate", "True");
2472 print_job->collate = FALSE;
2474 if (gtk_print_settings_get_reverse (settings))
2475 gtk_print_settings_set (settings, "cups-OutputOrder", "Reverse");
2476 print_job->reverse = FALSE;
2478 if (gtk_print_settings_get_n_copies (settings) > 1)
2479 gtk_print_settings_set_int (settings, "cups-copies",
2480 gtk_print_settings_get_n_copies (settings));
2481 print_job->num_copies = 1;
2483 scale = gtk_print_settings_get_scale (settings);
2484 print_job->scale = 1.0;
2486 print_job->scale = scale/100.0;
2488 page_set = gtk_print_settings_get_page_set (settings);
2489 if (page_set == GTK_PAGE_SET_EVEN)
2490 gtk_print_settings_set (settings, "cups-page-set", "even");
2491 else if (page_set == GTK_PAGE_SET_ODD)
2492 gtk_print_settings_set (settings, "cups-page-set", "odd");
2493 print_job->page_set = GTK_PAGE_SET_ALL;
2495 paper_size = gtk_page_setup_get_paper_size (page_setup);
2496 ppd_paper_name = gtk_paper_size_get_ppd_name (paper_size);
2497 if (ppd_paper_name != NULL)
2498 gtk_print_settings_set (settings, "cups-PageSize", ppd_paper_name);
2501 char *custom_name = g_strdup_printf ("Custom.%2fx%.2f",
2502 gtk_paper_size_get_width (paper_size, GTK_UNIT_POINTS),
2503 gtk_paper_size_get_height (paper_size, GTK_UNIT_POINTS));
2504 gtk_print_settings_set (settings, "cups-PageSize", custom_name);
2505 g_free (custom_name);
2508 print_job->rotate_to_orientation = TRUE;
2512 cups_printer_list_papers (GtkPrinter *printer)
2514 ppd_file_t *ppd_file;
2517 GtkPageSetup *page_setup;
2518 GtkPaperSize *paper_size;
2519 ppd_option_t *option;
2520 ppd_choice_t *choice;
2524 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
2525 if (ppd_file == NULL)
2530 for (i = 0; i < ppd_file->num_sizes; i++)
2532 size = &ppd_file->sizes[i];
2534 display_name = NULL;
2535 option = ppdFindOption (ppd_file, "PageSize");
2538 choice = ppdFindChoice (option, size->name);
2540 display_name = ppd_text_to_utf8 (ppd_file, choice->text);
2542 if (display_name == NULL)
2543 display_name = g_strdup (size->name);
2545 page_setup = gtk_page_setup_new ();
2546 paper_size = gtk_paper_size_new_from_ppd (size->name,
2550 gtk_page_setup_set_paper_size (page_setup, paper_size);
2551 gtk_paper_size_free (paper_size);
2553 gtk_page_setup_set_top_margin (page_setup, size->length - size->top, GTK_UNIT_POINTS);
2554 gtk_page_setup_set_bottom_margin (page_setup, size->bottom, GTK_UNIT_POINTS);
2555 gtk_page_setup_set_left_margin (page_setup, size->left, GTK_UNIT_POINTS);
2556 gtk_page_setup_set_right_margin (page_setup, size->width - size->right, GTK_UNIT_POINTS);
2558 g_free (display_name);
2560 l = g_list_prepend (l, page_setup);
2563 return g_list_reverse (l);
2567 cups_printer_get_hard_margins (GtkPrinter *printer,
2573 ppd_file_t *ppd_file;
2575 ppd_file = gtk_printer_cups_get_ppd (GTK_PRINTER_CUPS (printer));
2576 if (ppd_file == NULL)
2579 *left = ppd_file->custom_margins[0];
2580 *bottom = ppd_file->custom_margins[1];
2581 *right = ppd_file->custom_margins[2];
2582 *top = ppd_file->custom_margins[3];
2585 static GtkPrintCapabilities
2586 cups_printer_get_capabilities (GtkPrinter *printer)
2589 GTK_PRINT_CAPABILITY_COPIES |
2590 GTK_PRINT_CAPABILITY_COLLATE |
2591 GTK_PRINT_CAPABILITY_REVERSE;