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, see <http://www.gnu.org/licenses/>.
25 #include "gtkmodules.h"
26 #include "gtkmodulesprivate.h"
27 #include "gtkmarshalers.h"
28 #include "gtkprivate.h"
29 #include "gtkprintbackend.h"
32 static void gtk_print_backend_dispose (GObject *object);
33 static void gtk_print_backend_set_property (GObject *object,
37 static void gtk_print_backend_get_property (GObject *object,
42 struct _GtkPrintBackendPrivate
45 guint printer_list_requested : 1;
46 guint printer_list_done : 1;
47 GtkPrintBackendStatus status;
48 char **auth_info_required;
57 PRINTER_STATUS_CHANGED,
62 static guint signals[LAST_SIGNAL] = { 0 };
70 static GObjectClass *backend_parent_class;
73 gtk_print_backend_error_quark (void)
75 static GQuark quark = 0;
77 quark = g_quark_from_static_string ("gtk-print-backend-error-quark");
81 /*****************************************
82 * GtkPrintBackendModule modules *
83 *****************************************/
85 typedef struct _GtkPrintBackendModule GtkPrintBackendModule;
86 typedef struct _GtkPrintBackendModuleClass GtkPrintBackendModuleClass;
88 struct _GtkPrintBackendModule
90 GTypeModule parent_instance;
94 void (*init) (GTypeModule *module);
96 GtkPrintBackend* (*create) (void);
101 struct _GtkPrintBackendModuleClass
103 GTypeModuleClass parent_class;
106 GType _gtk_print_backend_module_get_type (void);
108 G_DEFINE_TYPE (GtkPrintBackendModule, _gtk_print_backend_module, G_TYPE_TYPE_MODULE)
109 #define GTK_TYPE_PRINT_BACKEND_MODULE (_gtk_print_backend_module_get_type ())
110 #define GTK_PRINT_BACKEND_MODULE(module) (G_TYPE_CHECK_INSTANCE_CAST ((module), GTK_TYPE_PRINT_BACKEND_MODULE, GtkPrintBackendModule))
112 static GSList *loaded_backends;
115 gtk_print_backend_module_load (GTypeModule *module)
117 GtkPrintBackendModule *pb_module = GTK_PRINT_BACKEND_MODULE (module);
118 gpointer initp, exitp, createp;
120 pb_module->library = g_module_open (pb_module->path, G_MODULE_BIND_LAZY | G_MODULE_BIND_LOCAL);
121 if (!pb_module->library)
123 g_warning ("%s", g_module_error());
127 /* extract symbols from the lib */
128 if (!g_module_symbol (pb_module->library, "pb_module_init",
130 !g_module_symbol (pb_module->library, "pb_module_exit",
132 !g_module_symbol (pb_module->library, "pb_module_create",
135 g_warning ("%s", g_module_error());
136 g_module_close (pb_module->library);
141 pb_module->init = initp;
142 pb_module->exit = exitp;
143 pb_module->create = createp;
145 /* call the printbackend's init function to let it */
146 /* setup anything it needs to set up. */
147 pb_module->init (module);
153 gtk_print_backend_module_unload (GTypeModule *module)
155 GtkPrintBackendModule *pb_module = GTK_PRINT_BACKEND_MODULE (module);
159 g_module_close (pb_module->library);
160 pb_module->library = NULL;
162 pb_module->init = NULL;
163 pb_module->exit = NULL;
164 pb_module->create = NULL;
167 /* This only will ever be called if an error occurs during
171 gtk_print_backend_module_finalize (GObject *object)
173 GtkPrintBackendModule *module = GTK_PRINT_BACKEND_MODULE (object);
175 g_free (module->path);
177 G_OBJECT_CLASS (_gtk_print_backend_module_parent_class)->finalize (object);
181 _gtk_print_backend_module_class_init (GtkPrintBackendModuleClass *class)
183 GTypeModuleClass *module_class = G_TYPE_MODULE_CLASS (class);
184 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
186 module_class->load = gtk_print_backend_module_load;
187 module_class->unload = gtk_print_backend_module_unload;
189 gobject_class->finalize = gtk_print_backend_module_finalize;
193 gtk_print_backend_set_property (GObject *object,
198 GtkPrintBackend *backend = GTK_PRINT_BACKEND (object);
199 GtkPrintBackendPrivate *priv = backend->priv;
204 priv->status = g_value_get_int (value);
207 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
213 gtk_print_backend_get_property (GObject *object,
218 GtkPrintBackend *backend = GTK_PRINT_BACKEND (object);
219 GtkPrintBackendPrivate *priv = backend->priv;
224 g_value_set_int (value, priv->status);
227 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
233 _gtk_print_backend_module_init (GtkPrintBackendModule *pb_module)
237 static GtkPrintBackend *
238 _gtk_print_backend_module_create (GtkPrintBackendModule *pb_module)
242 if (g_type_module_use (G_TYPE_MODULE (pb_module)))
244 pb = pb_module->create ();
245 g_type_module_unuse (G_TYPE_MODULE (pb_module));
251 static GtkPrintBackend *
252 _gtk_print_backend_create (const gchar *backend_name)
257 GtkPrintBackendModule *pb_module;
260 for (l = loaded_backends; l != NULL; l = l->next)
264 if (strcmp (G_TYPE_MODULE (pb_module)->name, backend_name) == 0)
265 return _gtk_print_backend_module_create (pb_module);
269 if (g_module_supported ())
271 full_name = g_strconcat ("printbackend-", backend_name, NULL);
272 module_path = _gtk_find_module (full_name, "printbackends");
277 pb_module = g_object_new (GTK_TYPE_PRINT_BACKEND_MODULE, NULL);
279 g_type_module_set_name (G_TYPE_MODULE (pb_module), backend_name);
280 pb_module->path = g_strdup (module_path);
282 loaded_backends = g_slist_prepend (loaded_backends,
285 pb = _gtk_print_backend_module_create (pb_module);
287 /* Increase use-count so that we don't unload print backends.
288 * There is a problem with module unloading in the cups module,
289 * see cups_dispatch_watch_finalize for details.
291 g_type_module_use (G_TYPE_MODULE (pb_module));
294 g_free (module_path);
301 * gtk_print_backend_load_modules:
303 * Return value: (element-type GtkPrintBackend) (transfer container):
306 gtk_print_backend_load_modules (void)
309 GtkPrintBackend *backend;
313 GtkSettings *settings;
317 settings = gtk_settings_get_default ();
319 g_object_get (settings, "gtk-print-backends", &setting, NULL);
321 setting = g_strdup (GTK_PRINT_BACKENDS);
323 backends = g_strsplit (setting, ",", -1);
325 for (i = 0; backends[i]; i++)
327 g_strchug (backends[i]);
328 g_strchomp (backends[i]);
329 backend = _gtk_print_backend_create (backends[i]);
332 result = g_list_append (result, backend);
335 g_strfreev (backends);
341 /*****************************************
343 *****************************************/
345 G_DEFINE_TYPE (GtkPrintBackend, gtk_print_backend, G_TYPE_OBJECT)
347 static void fallback_printer_request_details (GtkPrinter *printer);
348 static gboolean fallback_printer_mark_conflicts (GtkPrinter *printer,
349 GtkPrinterOptionSet *options);
350 static gboolean fallback_printer_get_hard_margins (GtkPrinter *printer,
355 static GList * fallback_printer_list_papers (GtkPrinter *printer);
356 static GtkPageSetup * fallback_printer_get_default_page_size (GtkPrinter *printer);
357 static GtkPrintCapabilities fallback_printer_get_capabilities (GtkPrinter *printer);
358 static void request_password (GtkPrintBackend *backend,
359 gpointer auth_info_required,
360 gpointer auth_info_default,
361 gpointer auth_info_display,
362 gpointer auth_info_visible,
363 const gchar *prompt);
366 gtk_print_backend_class_init (GtkPrintBackendClass *class)
368 GObjectClass *object_class;
369 object_class = (GObjectClass *) class;
371 backend_parent_class = g_type_class_peek_parent (class);
373 object_class->dispose = gtk_print_backend_dispose;
374 object_class->set_property = gtk_print_backend_set_property;
375 object_class->get_property = gtk_print_backend_get_property;
377 class->printer_request_details = fallback_printer_request_details;
378 class->printer_mark_conflicts = fallback_printer_mark_conflicts;
379 class->printer_get_hard_margins = fallback_printer_get_hard_margins;
380 class->printer_list_papers = fallback_printer_list_papers;
381 class->printer_get_default_page_size = fallback_printer_get_default_page_size;
382 class->printer_get_capabilities = fallback_printer_get_capabilities;
383 class->request_password = request_password;
385 g_object_class_install_property (object_class,
387 g_param_spec_int ("status",
389 "The status of the print backend",
390 GTK_PRINT_BACKEND_STATUS_UNKNOWN,
391 GTK_PRINT_BACKEND_STATUS_UNAVAILABLE,
392 GTK_PRINT_BACKEND_STATUS_UNKNOWN,
393 GTK_PARAM_READWRITE));
395 g_type_class_add_private (class, sizeof (GtkPrintBackendPrivate));
397 signals[PRINTER_LIST_CHANGED] =
398 g_signal_new (I_("printer-list-changed"),
399 G_TYPE_FROM_CLASS (class),
401 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_list_changed),
403 g_cclosure_marshal_VOID__VOID,
405 signals[PRINTER_LIST_DONE] =
406 g_signal_new (I_("printer-list-done"),
407 G_TYPE_FROM_CLASS (class),
409 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_list_done),
411 g_cclosure_marshal_VOID__VOID,
413 signals[PRINTER_ADDED] =
414 g_signal_new (I_("printer-added"),
415 G_TYPE_FROM_CLASS (class),
417 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_added),
419 g_cclosure_marshal_VOID__OBJECT,
420 G_TYPE_NONE, 1, GTK_TYPE_PRINTER);
421 signals[PRINTER_REMOVED] =
422 g_signal_new (I_("printer-removed"),
423 G_TYPE_FROM_CLASS (class),
425 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_removed),
427 g_cclosure_marshal_VOID__OBJECT,
428 G_TYPE_NONE, 1, GTK_TYPE_PRINTER);
429 signals[PRINTER_STATUS_CHANGED] =
430 g_signal_new (I_("printer-status-changed"),
431 G_TYPE_FROM_CLASS (class),
433 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_status_changed),
435 g_cclosure_marshal_VOID__OBJECT,
436 G_TYPE_NONE, 1, GTK_TYPE_PRINTER);
437 signals[REQUEST_PASSWORD] =
438 g_signal_new (I_("request-password"),
439 G_TYPE_FROM_CLASS (class),
441 G_STRUCT_OFFSET (GtkPrintBackendClass, request_password),
443 _gtk_marshal_VOID__POINTER_POINTER_POINTER_POINTER_STRING,
444 G_TYPE_NONE, 5, G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_STRING);
448 gtk_print_backend_init (GtkPrintBackend *backend)
450 GtkPrintBackendPrivate *priv;
452 priv = backend->priv = G_TYPE_INSTANCE_GET_PRIVATE (backend,
453 GTK_TYPE_PRINT_BACKEND,
454 GtkPrintBackendPrivate);
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,
508 fallback_printer_list_papers (GtkPrinter *printer)
513 static GtkPageSetup *
514 fallback_printer_get_default_page_size (GtkPrinter *printer)
519 static GtkPrintCapabilities
520 fallback_printer_get_capabilities (GtkPrinter *printer)
527 printer_hash_to_sorted_active_list (const gchar *key,
533 printer = GTK_PRINTER (value);
535 if (gtk_printer_get_name (printer) == NULL)
538 if (!gtk_printer_is_active (printer))
541 *out_list = g_list_insert_sorted (*out_list, value, (GCompareFunc) gtk_printer_compare);
546 gtk_print_backend_add_printer (GtkPrintBackend *backend,
549 GtkPrintBackendPrivate *priv;
551 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
553 priv = backend->priv;
558 g_hash_table_insert (priv->printers,
559 g_strdup (gtk_printer_get_name (printer)),
560 g_object_ref (printer));
564 gtk_print_backend_remove_printer (GtkPrintBackend *backend,
567 GtkPrintBackendPrivate *priv;
569 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
570 priv = backend->priv;
575 g_hash_table_remove (priv->printers,
576 gtk_printer_get_name (printer));
580 gtk_print_backend_set_list_done (GtkPrintBackend *backend)
582 if (!backend->priv->printer_list_done)
584 backend->priv->printer_list_done = TRUE;
585 g_signal_emit (backend, signals[PRINTER_LIST_DONE], 0);
591 * gtk_print_backend_get_printer_list:
593 * Returns the current list of printers.
595 * Return value: (element-type GtkPrinter) (transfer container):
596 * A list of #GtkPrinter objects. The list should be freed
597 * with g_list_free().
600 gtk_print_backend_get_printer_list (GtkPrintBackend *backend)
602 GtkPrintBackendPrivate *priv;
605 g_return_val_if_fail (GTK_IS_PRINT_BACKEND (backend), NULL);
607 priv = backend->priv;
610 if (priv->printers != NULL)
611 g_hash_table_foreach (priv->printers,
612 (GHFunc) printer_hash_to_sorted_active_list,
615 if (!priv->printer_list_requested && priv->printers != NULL)
617 if (GTK_PRINT_BACKEND_GET_CLASS (backend)->request_printer_list)
618 GTK_PRINT_BACKEND_GET_CLASS (backend)->request_printer_list (backend);
619 priv->printer_list_requested = TRUE;
626 gtk_print_backend_printer_list_is_done (GtkPrintBackend *print_backend)
628 g_return_val_if_fail (GTK_IS_PRINT_BACKEND (print_backend), TRUE);
630 return print_backend->priv->printer_list_done;
634 gtk_print_backend_find_printer (GtkPrintBackend *backend,
635 const gchar *printer_name)
637 GtkPrintBackendPrivate *priv;
640 g_return_val_if_fail (GTK_IS_PRINT_BACKEND (backend), NULL);
642 priv = backend->priv;
645 printer = g_hash_table_lookup (priv->printers, printer_name);
653 gtk_print_backend_print_stream (GtkPrintBackend *backend,
656 GtkPrintJobCompleteFunc callback,
658 GDestroyNotify dnotify)
660 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
662 GTK_PRINT_BACKEND_GET_CLASS (backend)->print_stream (backend,
671 gtk_print_backend_set_password (GtkPrintBackend *backend,
672 gchar **auth_info_required,
675 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
677 if (GTK_PRINT_BACKEND_GET_CLASS (backend)->set_password)
678 GTK_PRINT_BACKEND_GET_CLASS (backend)->set_password (backend, auth_info_required, auth_info);
682 store_entry (GtkEntry *entry,
685 gchar **data = (gchar **) user_data;
689 memset (*data, 0, strlen (*data));
693 *data = g_strdup (gtk_entry_get_text (entry));
697 password_dialog_response (GtkWidget *dialog,
699 GtkPrintBackend *backend)
701 GtkPrintBackendPrivate *priv = backend->priv;
704 if (response_id == GTK_RESPONSE_OK)
705 gtk_print_backend_set_password (backend, priv->auth_info_required, priv->auth_info);
707 gtk_print_backend_set_password (backend, priv->auth_info_required, NULL);
709 for (i = 0; i < g_strv_length (priv->auth_info_required); i++)
710 if (priv->auth_info[i] != NULL)
712 memset (priv->auth_info[i], 0, strlen (priv->auth_info[i]));
713 g_free (priv->auth_info[i]);
714 priv->auth_info[i] = NULL;
716 g_free (priv->auth_info);
717 priv->auth_info = NULL;
719 g_strfreev (priv->auth_info_required);
721 gtk_widget_destroy (dialog);
723 g_object_unref (backend);
727 request_password (GtkPrintBackend *backend,
728 gpointer auth_info_required,
729 gpointer auth_info_default,
730 gpointer auth_info_display,
731 gpointer auth_info_visible,
734 GtkPrintBackendPrivate *priv = backend->priv;
735 GtkWidget *dialog, *box, *main_box, *label, *icon, *vbox, *entry;
736 GtkWidget *focus = NULL;
737 GtkWidget *content_area;
741 gchar **ai_required = (gchar **) auth_info_required;
742 gchar **ai_default = (gchar **) auth_info_default;
743 gchar **ai_display = (gchar **) auth_info_display;
744 gboolean *ai_visible = (gboolean *) auth_info_visible;
746 priv->auth_info_required = g_strdupv (ai_required);
747 length = g_strv_length (ai_required);
748 priv->auth_info = g_new0 (gchar *, length);
750 dialog = gtk_dialog_new_with_buttons ( _("Authentication"), NULL, GTK_DIALOG_MODAL,
751 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
752 GTK_STOCK_OK, GTK_RESPONSE_OK,
755 gtk_dialog_set_default_response (GTK_DIALOG (dialog), GTK_RESPONSE_OK);
757 main_box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
760 icon = gtk_image_new_from_stock (GTK_STOCK_DIALOG_AUTHENTICATION, GTK_ICON_SIZE_DIALOG);
761 gtk_widget_set_halign (icon, GTK_ALIGN_CENTER);
762 gtk_widget_set_valign (icon, GTK_ALIGN_START);
763 g_object_set (icon, "margin", 6, NULL);
766 vbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
767 gtk_widget_set_size_request (GTK_WIDGET (vbox), 320, -1);
770 label = gtk_label_new (NULL);
771 markup = g_markup_printf_escaped ("<span weight=\"bold\" size=\"large\">%s</span>", prompt);
772 gtk_label_set_markup (GTK_LABEL (label), markup);
773 gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
774 gtk_widget_set_size_request (GTK_WIDGET (label), 320, -1);
779 content_area = gtk_dialog_get_content_area (GTK_DIALOG (dialog));
780 gtk_box_pack_start (GTK_BOX (content_area), main_box, TRUE, FALSE, 0);
782 gtk_box_pack_start (GTK_BOX (main_box), icon, FALSE, FALSE, 6);
783 gtk_box_pack_start (GTK_BOX (main_box), vbox, FALSE, FALSE, 6);
785 gtk_box_pack_start (GTK_BOX (vbox), label, FALSE, TRUE, 6);
788 for (i = 0; i < length; i++)
790 priv->auth_info[i] = g_strdup (ai_default[i]);
791 if (ai_display[i] != NULL)
793 box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
794 gtk_box_set_homogeneous (GTK_BOX (box), TRUE);
796 label = gtk_label_new (ai_display[i]);
797 gtk_widget_set_halign (label, GTK_ALIGN_START);
798 gtk_widget_set_valign (label, GTK_ALIGN_CENTER);
800 entry = gtk_entry_new ();
803 if (ai_default[i] != NULL)
804 gtk_entry_set_text (GTK_ENTRY (entry), ai_default[i]);
806 gtk_entry_set_visibility (GTK_ENTRY (entry), ai_visible[i]);
807 gtk_entry_set_activates_default (GTK_ENTRY (entry), TRUE);
809 gtk_box_pack_start (GTK_BOX (vbox), box, FALSE, TRUE, 6);
811 gtk_box_pack_start (GTK_BOX (box), label, TRUE, TRUE, 0);
812 gtk_box_pack_start (GTK_BOX (box), entry, TRUE, TRUE, 0);
814 g_signal_connect (entry, "changed",
815 G_CALLBACK (store_entry), &(priv->auth_info[i]));
821 gtk_widget_grab_focus (focus);
825 g_object_ref (backend);
826 g_signal_connect (G_OBJECT (dialog), "response",
827 G_CALLBACK (password_dialog_response), backend);
829 gtk_widget_show_all (dialog);
833 gtk_print_backend_destroy (GtkPrintBackend *print_backend)
835 /* The lifecycle of print backends and printers are tied, such that
836 * the backend owns the printers, but the printers also ref the backend.
837 * This is so that if the app has a reference to a printer its backend
838 * will be around. However, this results in a cycle, which we break
839 * with this call, which causes the print backend to release its printers.
841 g_object_run_dispose (G_OBJECT (print_backend));