1 /* GTK - The GIMP Toolkit
2 * gtkprintbackend.h: Abstract printer backend interfaces
3 * Copyright (C) 2003, Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
27 #include "gtkmodules.h"
28 #include "gtkmarshalers.h"
29 #include "gtkprivate.h"
30 #include "gtkprintbackend.h"
31 #include "gtkprinter-private.h"
34 #define GTK_PRINT_BACKEND_GET_PRIVATE(o) \
35 (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_PRINT_BACKEND, GtkPrintBackendPrivate))
37 static void gtk_print_backend_dispose (GObject *object);
38 static void gtk_print_backend_set_property (GObject *object,
42 static void gtk_print_backend_get_property (GObject *object,
47 struct _GtkPrintBackendPrivate
50 guint printer_list_requested : 1;
51 guint printer_list_done : 1;
52 GtkPrintBackendStatus status;
53 char **auth_info_required;
62 PRINTER_STATUS_CHANGED,
67 static guint signals[LAST_SIGNAL] = { 0 };
75 static GObjectClass *backend_parent_class;
78 gtk_print_backend_error_quark (void)
80 static GQuark quark = 0;
82 quark = g_quark_from_static_string ("gtk-print-backend-error-quark");
86 /*****************************************
87 * GtkPrintBackendModule modules *
88 *****************************************/
90 typedef struct _GtkPrintBackendModule GtkPrintBackendModule;
91 typedef struct _GtkPrintBackendModuleClass GtkPrintBackendModuleClass;
93 struct _GtkPrintBackendModule
95 GTypeModule parent_instance;
99 void (*init) (GTypeModule *module);
101 GtkPrintBackend* (*create) (void);
106 struct _GtkPrintBackendModuleClass
108 GTypeModuleClass parent_class;
111 G_DEFINE_TYPE (GtkPrintBackendModule, _gtk_print_backend_module, G_TYPE_TYPE_MODULE)
112 #define GTK_TYPE_PRINT_BACKEND_MODULE (_gtk_print_backend_module_get_type ())
113 #define GTK_PRINT_BACKEND_MODULE(module) (G_TYPE_CHECK_INSTANCE_CAST ((module), GTK_TYPE_PRINT_BACKEND_MODULE, GtkPrintBackendModule))
115 static GSList *loaded_backends;
118 gtk_print_backend_module_load (GTypeModule *module)
120 GtkPrintBackendModule *pb_module = GTK_PRINT_BACKEND_MODULE (module);
121 gpointer initp, exitp, createp;
123 pb_module->library = g_module_open (pb_module->path, G_MODULE_BIND_LAZY | G_MODULE_BIND_LOCAL);
124 if (!pb_module->library)
126 g_warning ("%s", g_module_error());
130 /* extract symbols from the lib */
131 if (!g_module_symbol (pb_module->library, "pb_module_init",
133 !g_module_symbol (pb_module->library, "pb_module_exit",
135 !g_module_symbol (pb_module->library, "pb_module_create",
138 g_warning ("%s", g_module_error());
139 g_module_close (pb_module->library);
144 pb_module->init = initp;
145 pb_module->exit = exitp;
146 pb_module->create = createp;
148 /* call the printbackend's init function to let it */
149 /* setup anything it needs to set up. */
150 pb_module->init (module);
156 gtk_print_backend_module_unload (GTypeModule *module)
158 GtkPrintBackendModule *pb_module = GTK_PRINT_BACKEND_MODULE (module);
162 g_module_close (pb_module->library);
163 pb_module->library = NULL;
165 pb_module->init = NULL;
166 pb_module->exit = NULL;
167 pb_module->create = NULL;
170 /* This only will ever be called if an error occurs during
174 gtk_print_backend_module_finalize (GObject *object)
176 GtkPrintBackendModule *module = GTK_PRINT_BACKEND_MODULE (object);
178 g_free (module->path);
180 G_OBJECT_CLASS (_gtk_print_backend_module_parent_class)->finalize (object);
184 _gtk_print_backend_module_class_init (GtkPrintBackendModuleClass *class)
186 GTypeModuleClass *module_class = G_TYPE_MODULE_CLASS (class);
187 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
189 module_class->load = gtk_print_backend_module_load;
190 module_class->unload = gtk_print_backend_module_unload;
192 gobject_class->finalize = gtk_print_backend_module_finalize;
196 gtk_print_backend_set_property (GObject *object,
201 GtkPrintBackend *backend = GTK_PRINT_BACKEND (object);
202 GtkPrintBackendPrivate *priv;
204 priv = backend->priv = GTK_PRINT_BACKEND_GET_PRIVATE (backend);
209 priv->status = g_value_get_int (value);
212 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
218 gtk_print_backend_get_property (GObject *object,
223 GtkPrintBackend *backend = GTK_PRINT_BACKEND (object);
224 GtkPrintBackendPrivate *priv;
226 priv = backend->priv = GTK_PRINT_BACKEND_GET_PRIVATE (backend);
231 g_value_set_int (value, priv->status);
234 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
240 _gtk_print_backend_module_init (GtkPrintBackendModule *pb_module)
244 static GtkPrintBackend *
245 _gtk_print_backend_module_create (GtkPrintBackendModule *pb_module)
249 if (g_type_module_use (G_TYPE_MODULE (pb_module)))
251 pb = pb_module->create ();
252 g_type_module_unuse (G_TYPE_MODULE (pb_module));
258 static GtkPrintBackend *
259 _gtk_print_backend_create (const gchar *backend_name)
264 GtkPrintBackendModule *pb_module;
267 for (l = loaded_backends; l != NULL; l = l->next)
271 if (strcmp (G_TYPE_MODULE (pb_module)->name, backend_name) == 0)
272 return _gtk_print_backend_module_create (pb_module);
276 if (g_module_supported ())
278 full_name = g_strconcat ("printbackend-", backend_name, NULL);
279 module_path = _gtk_find_module (full_name, "printbackends");
284 pb_module = g_object_new (GTK_TYPE_PRINT_BACKEND_MODULE, NULL);
286 g_type_module_set_name (G_TYPE_MODULE (pb_module), backend_name);
287 pb_module->path = g_strdup (module_path);
289 loaded_backends = g_slist_prepend (loaded_backends,
292 pb = _gtk_print_backend_module_create (pb_module);
294 /* Increase use-count so that we don't unload print backends.
295 * There is a problem with module unloading in the cups module,
296 * see cups_dispatch_watch_finalize for details.
298 g_type_module_use (G_TYPE_MODULE (pb_module));
301 g_free (module_path);
308 gtk_print_backend_load_modules (void)
311 GtkPrintBackend *backend;
315 GtkSettings *settings;
319 settings = gtk_settings_get_default ();
321 g_object_get (settings, "gtk-print-backends", &setting, NULL);
323 setting = g_strdup (GTK_PRINT_BACKENDS);
325 backends = g_strsplit (setting, ",", -1);
327 for (i = 0; backends[i]; i++)
329 g_strchug (backends[i]);
330 g_strchomp (backends[i]);
331 backend = _gtk_print_backend_create (backends[i]);
334 result = g_list_append (result, backend);
337 g_strfreev (backends);
343 /*****************************************
345 *****************************************/
347 G_DEFINE_TYPE (GtkPrintBackend, gtk_print_backend, G_TYPE_OBJECT)
349 static void fallback_printer_request_details (GtkPrinter *printer);
350 static gboolean fallback_printer_mark_conflicts (GtkPrinter *printer,
351 GtkPrinterOptionSet *options);
352 static void fallback_printer_get_hard_margins (GtkPrinter *printer,
357 static GList * fallback_printer_list_papers (GtkPrinter *printer);
358 static GtkPageSetup * fallback_printer_get_default_page_size (GtkPrinter *printer);
359 static GtkPrintCapabilities fallback_printer_get_capabilities (GtkPrinter *printer);
360 static void request_password (GtkPrintBackend *backend,
361 gpointer auth_info_required,
362 gpointer auth_info_default,
363 gpointer auth_info_display,
364 gpointer auth_info_visible,
365 const gchar *prompt);
368 gtk_print_backend_class_init (GtkPrintBackendClass *class)
370 GObjectClass *object_class;
371 object_class = (GObjectClass *) class;
373 backend_parent_class = g_type_class_peek_parent (class);
375 object_class->dispose = gtk_print_backend_dispose;
376 object_class->set_property = gtk_print_backend_set_property;
377 object_class->get_property = gtk_print_backend_get_property;
379 class->printer_request_details = fallback_printer_request_details;
380 class->printer_mark_conflicts = fallback_printer_mark_conflicts;
381 class->printer_get_hard_margins = fallback_printer_get_hard_margins;
382 class->printer_list_papers = fallback_printer_list_papers;
383 class->printer_get_default_page_size = fallback_printer_get_default_page_size;
384 class->printer_get_capabilities = fallback_printer_get_capabilities;
385 class->request_password = request_password;
387 g_object_class_install_property (object_class,
389 g_param_spec_int ("status",
391 "The status of the print backend",
392 GTK_PRINT_BACKEND_STATUS_UNKNOWN,
393 GTK_PRINT_BACKEND_STATUS_UNAVAILABLE,
394 GTK_PRINT_BACKEND_STATUS_UNKNOWN,
395 GTK_PARAM_READWRITE));
397 g_type_class_add_private (class, sizeof (GtkPrintBackendPrivate));
399 signals[PRINTER_LIST_CHANGED] =
400 g_signal_new (I_("printer-list-changed"),
401 G_TYPE_FROM_CLASS (class),
403 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_list_changed),
405 g_cclosure_marshal_VOID__VOID,
407 signals[PRINTER_LIST_DONE] =
408 g_signal_new (I_("printer-list-done"),
409 G_TYPE_FROM_CLASS (class),
411 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_list_done),
413 g_cclosure_marshal_VOID__VOID,
415 signals[PRINTER_ADDED] =
416 g_signal_new (I_("printer-added"),
417 G_TYPE_FROM_CLASS (class),
419 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_added),
421 g_cclosure_marshal_VOID__OBJECT,
422 G_TYPE_NONE, 1, GTK_TYPE_PRINTER);
423 signals[PRINTER_REMOVED] =
424 g_signal_new (I_("printer-removed"),
425 G_TYPE_FROM_CLASS (class),
427 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_removed),
429 g_cclosure_marshal_VOID__OBJECT,
430 G_TYPE_NONE, 1, GTK_TYPE_PRINTER);
431 signals[PRINTER_STATUS_CHANGED] =
432 g_signal_new (I_("printer-status-changed"),
433 G_TYPE_FROM_CLASS (class),
435 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_status_changed),
437 g_cclosure_marshal_VOID__OBJECT,
438 G_TYPE_NONE, 1, GTK_TYPE_PRINTER);
439 signals[REQUEST_PASSWORD] =
440 g_signal_new (I_("request-password"),
441 G_TYPE_FROM_CLASS (class),
443 G_STRUCT_OFFSET (GtkPrintBackendClass, request_password),
445 _gtk_marshal_VOID__POINTER_POINTER_POINTER_POINTER_STRING,
446 G_TYPE_NONE, 5, G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_STRING);
450 gtk_print_backend_init (GtkPrintBackend *backend)
452 GtkPrintBackendPrivate *priv;
454 priv = backend->priv = GTK_PRINT_BACKEND_GET_PRIVATE (backend);
456 priv->printers = g_hash_table_new_full (g_str_hash, g_str_equal,
457 (GDestroyNotify) g_free,
458 (GDestroyNotify) g_object_unref);
459 priv->auth_info_required = NULL;
460 priv->auth_info = NULL;
464 gtk_print_backend_dispose (GObject *object)
466 GtkPrintBackend *backend;
467 GtkPrintBackendPrivate *priv;
469 backend = GTK_PRINT_BACKEND (object);
470 priv = backend->priv;
472 /* We unref the printers in dispose, not in finalize so that
473 * we can break refcount cycles with gtk_print_backend_destroy
477 g_hash_table_destroy (priv->printers);
478 priv->printers = NULL;
481 backend_parent_class->dispose (object);
486 fallback_printer_request_details (GtkPrinter *printer)
491 fallback_printer_mark_conflicts (GtkPrinter *printer,
492 GtkPrinterOptionSet *options)
498 fallback_printer_get_hard_margins (GtkPrinter *printer,
511 fallback_printer_list_papers (GtkPrinter *printer)
516 static GtkPageSetup *
517 fallback_printer_get_default_page_size (GtkPrinter *printer)
522 static GtkPrintCapabilities
523 fallback_printer_get_capabilities (GtkPrinter *printer)
530 printer_hash_to_sorted_active_list (const gchar *key,
536 printer = GTK_PRINTER (value);
538 if (gtk_printer_get_name (printer) == NULL)
541 if (!gtk_printer_is_active (printer))
544 *out_list = g_list_insert_sorted (*out_list, value, (GCompareFunc) gtk_printer_compare);
549 gtk_print_backend_add_printer (GtkPrintBackend *backend,
552 GtkPrintBackendPrivate *priv;
554 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
556 priv = backend->priv;
561 g_hash_table_insert (priv->printers,
562 g_strdup (gtk_printer_get_name (printer)),
563 g_object_ref (printer));
567 gtk_print_backend_remove_printer (GtkPrintBackend *backend,
570 GtkPrintBackendPrivate *priv;
572 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
573 priv = backend->priv;
578 g_hash_table_remove (priv->printers,
579 gtk_printer_get_name (printer));
583 gtk_print_backend_set_list_done (GtkPrintBackend *backend)
585 if (!backend->priv->printer_list_done)
587 backend->priv->printer_list_done = TRUE;
588 g_signal_emit (backend, signals[PRINTER_LIST_DONE], 0);
594 gtk_print_backend_get_printer_list (GtkPrintBackend *backend)
596 GtkPrintBackendPrivate *priv;
599 g_return_val_if_fail (GTK_IS_PRINT_BACKEND (backend), NULL);
601 priv = backend->priv;
604 if (priv->printers != NULL)
605 g_hash_table_foreach (priv->printers,
606 (GHFunc) printer_hash_to_sorted_active_list,
609 if (!priv->printer_list_requested && priv->printers != NULL)
611 if (GTK_PRINT_BACKEND_GET_CLASS (backend)->request_printer_list)
612 GTK_PRINT_BACKEND_GET_CLASS (backend)->request_printer_list (backend);
613 priv->printer_list_requested = TRUE;
620 gtk_print_backend_printer_list_is_done (GtkPrintBackend *print_backend)
622 g_return_val_if_fail (GTK_IS_PRINT_BACKEND (print_backend), TRUE);
624 return print_backend->priv->printer_list_done;
628 gtk_print_backend_find_printer (GtkPrintBackend *backend,
629 const gchar *printer_name)
631 GtkPrintBackendPrivate *priv;
634 g_return_val_if_fail (GTK_IS_PRINT_BACKEND (backend), NULL);
636 priv = backend->priv;
639 printer = g_hash_table_lookup (priv->printers, printer_name);
647 gtk_print_backend_print_stream (GtkPrintBackend *backend,
650 GtkPrintJobCompleteFunc callback,
652 GDestroyNotify dnotify)
654 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
656 GTK_PRINT_BACKEND_GET_CLASS (backend)->print_stream (backend,
665 gtk_print_backend_set_password (GtkPrintBackend *backend,
666 gchar **auth_info_required,
669 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
671 if (GTK_PRINT_BACKEND_GET_CLASS (backend)->set_password)
672 GTK_PRINT_BACKEND_GET_CLASS (backend)->set_password (backend, auth_info_required, auth_info);
676 store_entry (GtkEntry *entry,
679 gchar **data = (gchar **) user_data;
683 memset (*data, 0, strlen (*data));
687 *data = g_strdup (gtk_entry_get_text (entry));
691 password_dialog_response (GtkWidget *dialog,
693 GtkPrintBackend *backend)
695 GtkPrintBackendPrivate *priv = backend->priv;
698 if (response_id == GTK_RESPONSE_OK)
699 gtk_print_backend_set_password (backend, priv->auth_info_required, priv->auth_info);
701 gtk_print_backend_set_password (backend, priv->auth_info_required, NULL);
703 for (i = 0; i < g_strv_length (priv->auth_info_required); i++)
704 if (priv->auth_info[i] != NULL)
706 memset (priv->auth_info[i], 0, strlen (priv->auth_info[i]));
707 g_free (priv->auth_info[i]);
708 priv->auth_info[i] = NULL;
710 g_free (priv->auth_info);
711 priv->auth_info = NULL;
713 g_strfreev (priv->auth_info_required);
715 gtk_widget_destroy (dialog);
717 g_object_unref (backend);
721 request_password (GtkPrintBackend *backend,
722 gpointer auth_info_required,
723 gpointer auth_info_default,
724 gpointer auth_info_display,
725 gpointer auth_info_visible,
728 GtkPrintBackendPrivate *priv = backend->priv;
729 GtkWidget *dialog, *box, *main_box, *label, *icon, *vbox, *entry;
730 GtkWidget *focus = NULL;
734 gchar **ai_required = (gchar **) auth_info_required;
735 gchar **ai_default = (gchar **) auth_info_default;
736 gchar **ai_display = (gchar **) auth_info_display;
737 gboolean *ai_visible = (gboolean *) auth_info_visible;
739 priv->auth_info_required = g_strdupv (ai_required);
740 length = g_strv_length (ai_required);
741 priv->auth_info = g_new0 (gchar *, length);
743 dialog = gtk_dialog_new_with_buttons ( _("Authentication"), NULL, GTK_DIALOG_MODAL,
744 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
745 GTK_STOCK_OK, GTK_RESPONSE_OK,
748 gtk_dialog_set_default_response (GTK_DIALOG (dialog), GTK_RESPONSE_OK);
749 gtk_dialog_set_has_separator (GTK_DIALOG (dialog), FALSE);
751 main_box = gtk_hbox_new (FALSE, 0);
754 icon = gtk_image_new_from_stock (GTK_STOCK_DIALOG_AUTHENTICATION, GTK_ICON_SIZE_DIALOG);
755 gtk_misc_set_alignment (GTK_MISC (icon), 0.5, 0.0);
756 gtk_misc_set_padding (GTK_MISC (icon), 6, 6);
760 vbox = gtk_vbox_new (FALSE, 0);
761 gtk_widget_set_size_request (GTK_WIDGET (vbox), 320, -1);
764 label = gtk_label_new (NULL);
765 markup = g_markup_printf_escaped ("<span weight=\"bold\" size=\"large\">%s</span>", prompt);
766 gtk_label_set_markup (GTK_LABEL (label), markup);
767 gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
768 gtk_widget_set_size_request (GTK_WIDGET (label), 320, -1);
773 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox), main_box, TRUE, FALSE, 0);
775 gtk_box_pack_start (GTK_BOX (main_box), icon, FALSE, FALSE, 6);
776 gtk_box_pack_start (GTK_BOX (main_box), vbox, FALSE, FALSE, 6);
778 gtk_box_pack_start (GTK_BOX (vbox), label, FALSE, TRUE, 6);
781 for (i = 0; i < length; i++)
783 priv->auth_info[i] = g_strdup (ai_default[i]);
784 if (ai_display[i] != NULL)
786 box = gtk_hbox_new (TRUE, 0);
788 label = gtk_label_new (ai_display[i]);
789 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
791 entry = gtk_entry_new ();
794 if (ai_default[i] != NULL)
795 gtk_entry_set_text (GTK_ENTRY (entry), ai_default[i]);
797 gtk_entry_set_visibility (GTK_ENTRY (entry), ai_visible[i]);
798 gtk_entry_set_activates_default (GTK_ENTRY (entry), TRUE);
800 gtk_box_pack_start (GTK_BOX (vbox), box, FALSE, TRUE, 6);
802 gtk_box_pack_start (GTK_BOX (box), label, TRUE, TRUE, 0);
803 gtk_box_pack_start (GTK_BOX (box), entry, TRUE, TRUE, 0);
805 g_signal_connect (entry, "changed",
806 G_CALLBACK (store_entry), &(priv->auth_info[i]));
812 gtk_widget_grab_focus (focus);
816 g_object_ref (backend);
817 g_signal_connect (G_OBJECT (dialog), "response",
818 G_CALLBACK (password_dialog_response), backend);
820 gtk_widget_show_all (dialog);
824 gtk_print_backend_destroy (GtkPrintBackend *print_backend)
826 /* The lifecycle of print backends and printers are tied, such that
827 * the backend owns the printers, but the printers also ref the backend.
828 * This is so that if the app has a reference to a printer its backend
829 * will be around. However, this results in a cycle, which we break
830 * with this call, which causes the print backend to release its printers.
832 g_object_run_dispose (G_OBJECT (print_backend));
836 #define __GTK_PRINT_BACKEND_C__
837 #include "gtkaliasdef.c"