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"
33 static void gtk_print_backend_dispose (GObject *object);
34 static void gtk_print_backend_set_property (GObject *object,
38 static void gtk_print_backend_get_property (GObject *object,
43 struct _GtkPrintBackendPrivate
46 guint printer_list_requested : 1;
47 guint printer_list_done : 1;
48 GtkPrintBackendStatus status;
49 char **auth_info_required;
58 PRINTER_STATUS_CHANGED,
63 static guint signals[LAST_SIGNAL] = { 0 };
71 static GObjectClass *backend_parent_class;
74 gtk_print_backend_error_quark (void)
76 static GQuark quark = 0;
78 quark = g_quark_from_static_string ("gtk-print-backend-error-quark");
82 /*****************************************
83 * GtkPrintBackendModule modules *
84 *****************************************/
86 typedef struct _GtkPrintBackendModule GtkPrintBackendModule;
87 typedef struct _GtkPrintBackendModuleClass GtkPrintBackendModuleClass;
89 struct _GtkPrintBackendModule
91 GTypeModule parent_instance;
95 void (*init) (GTypeModule *module);
97 GtkPrintBackend* (*create) (void);
102 struct _GtkPrintBackendModuleClass
104 GTypeModuleClass parent_class;
107 G_DEFINE_TYPE (GtkPrintBackendModule, _gtk_print_backend_module, G_TYPE_TYPE_MODULE)
108 #define GTK_TYPE_PRINT_BACKEND_MODULE (_gtk_print_backend_module_get_type ())
109 #define GTK_PRINT_BACKEND_MODULE(module) (G_TYPE_CHECK_INSTANCE_CAST ((module), GTK_TYPE_PRINT_BACKEND_MODULE, GtkPrintBackendModule))
111 static GSList *loaded_backends;
114 gtk_print_backend_module_load (GTypeModule *module)
116 GtkPrintBackendModule *pb_module = GTK_PRINT_BACKEND_MODULE (module);
117 gpointer initp, exitp, createp;
119 pb_module->library = g_module_open (pb_module->path, G_MODULE_BIND_LAZY | G_MODULE_BIND_LOCAL);
120 if (!pb_module->library)
122 g_warning ("%s", g_module_error());
126 /* extract symbols from the lib */
127 if (!g_module_symbol (pb_module->library, "pb_module_init",
129 !g_module_symbol (pb_module->library, "pb_module_exit",
131 !g_module_symbol (pb_module->library, "pb_module_create",
134 g_warning ("%s", g_module_error());
135 g_module_close (pb_module->library);
140 pb_module->init = initp;
141 pb_module->exit = exitp;
142 pb_module->create = createp;
144 /* call the printbackend's init function to let it */
145 /* setup anything it needs to set up. */
146 pb_module->init (module);
152 gtk_print_backend_module_unload (GTypeModule *module)
154 GtkPrintBackendModule *pb_module = GTK_PRINT_BACKEND_MODULE (module);
158 g_module_close (pb_module->library);
159 pb_module->library = NULL;
161 pb_module->init = NULL;
162 pb_module->exit = NULL;
163 pb_module->create = NULL;
166 /* This only will ever be called if an error occurs during
170 gtk_print_backend_module_finalize (GObject *object)
172 GtkPrintBackendModule *module = GTK_PRINT_BACKEND_MODULE (object);
174 g_free (module->path);
176 G_OBJECT_CLASS (_gtk_print_backend_module_parent_class)->finalize (object);
180 _gtk_print_backend_module_class_init (GtkPrintBackendModuleClass *class)
182 GTypeModuleClass *module_class = G_TYPE_MODULE_CLASS (class);
183 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
185 module_class->load = gtk_print_backend_module_load;
186 module_class->unload = gtk_print_backend_module_unload;
188 gobject_class->finalize = gtk_print_backend_module_finalize;
192 gtk_print_backend_set_property (GObject *object,
197 GtkPrintBackend *backend = GTK_PRINT_BACKEND (object);
198 GtkPrintBackendPrivate *priv = backend->priv;
203 priv->status = g_value_get_int (value);
206 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
212 gtk_print_backend_get_property (GObject *object,
217 GtkPrintBackend *backend = GTK_PRINT_BACKEND (object);
218 GtkPrintBackendPrivate *priv = backend->priv;
223 g_value_set_int (value, priv->status);
226 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
232 _gtk_print_backend_module_init (GtkPrintBackendModule *pb_module)
236 static GtkPrintBackend *
237 _gtk_print_backend_module_create (GtkPrintBackendModule *pb_module)
241 if (g_type_module_use (G_TYPE_MODULE (pb_module)))
243 pb = pb_module->create ();
244 g_type_module_unuse (G_TYPE_MODULE (pb_module));
250 static GtkPrintBackend *
251 _gtk_print_backend_create (const gchar *backend_name)
256 GtkPrintBackendModule *pb_module;
259 for (l = loaded_backends; l != NULL; l = l->next)
263 if (strcmp (G_TYPE_MODULE (pb_module)->name, backend_name) == 0)
264 return _gtk_print_backend_module_create (pb_module);
268 if (g_module_supported ())
270 full_name = g_strconcat ("printbackend-", backend_name, NULL);
271 module_path = _gtk_find_module (full_name, "printbackends");
276 pb_module = g_object_new (GTK_TYPE_PRINT_BACKEND_MODULE, NULL);
278 g_type_module_set_name (G_TYPE_MODULE (pb_module), backend_name);
279 pb_module->path = g_strdup (module_path);
281 loaded_backends = g_slist_prepend (loaded_backends,
284 pb = _gtk_print_backend_module_create (pb_module);
286 /* Increase use-count so that we don't unload print backends.
287 * There is a problem with module unloading in the cups module,
288 * see cups_dispatch_watch_finalize for details.
290 g_type_module_use (G_TYPE_MODULE (pb_module));
293 g_free (module_path);
300 * gtk_print_backend_load_modules:
302 * Return value: (element-type GtkPrintBackend) (transfer container):
305 gtk_print_backend_load_modules (void)
308 GtkPrintBackend *backend;
312 GtkSettings *settings;
316 settings = gtk_settings_get_default ();
318 g_object_get (settings, "gtk-print-backends", &setting, NULL);
320 setting = g_strdup (GTK_PRINT_BACKENDS);
322 backends = g_strsplit (setting, ",", -1);
324 for (i = 0; backends[i]; i++)
326 g_strchug (backends[i]);
327 g_strchomp (backends[i]);
328 backend = _gtk_print_backend_create (backends[i]);
331 result = g_list_append (result, backend);
334 g_strfreev (backends);
340 /*****************************************
342 *****************************************/
344 G_DEFINE_TYPE (GtkPrintBackend, gtk_print_backend, G_TYPE_OBJECT)
346 static void fallback_printer_request_details (GtkPrinter *printer);
347 static gboolean fallback_printer_mark_conflicts (GtkPrinter *printer,
348 GtkPrinterOptionSet *options);
349 static gboolean fallback_printer_get_hard_margins (GtkPrinter *printer,
354 static GList * fallback_printer_list_papers (GtkPrinter *printer);
355 static GtkPageSetup * fallback_printer_get_default_page_size (GtkPrinter *printer);
356 static GtkPrintCapabilities fallback_printer_get_capabilities (GtkPrinter *printer);
357 static void request_password (GtkPrintBackend *backend,
358 gpointer auth_info_required,
359 gpointer auth_info_default,
360 gpointer auth_info_display,
361 gpointer auth_info_visible,
362 const gchar *prompt);
365 gtk_print_backend_class_init (GtkPrintBackendClass *class)
367 GObjectClass *object_class;
368 object_class = (GObjectClass *) class;
370 backend_parent_class = g_type_class_peek_parent (class);
372 object_class->dispose = gtk_print_backend_dispose;
373 object_class->set_property = gtk_print_backend_set_property;
374 object_class->get_property = gtk_print_backend_get_property;
376 class->printer_request_details = fallback_printer_request_details;
377 class->printer_mark_conflicts = fallback_printer_mark_conflicts;
378 class->printer_get_hard_margins = fallback_printer_get_hard_margins;
379 class->printer_list_papers = fallback_printer_list_papers;
380 class->printer_get_default_page_size = fallback_printer_get_default_page_size;
381 class->printer_get_capabilities = fallback_printer_get_capabilities;
382 class->request_password = request_password;
384 g_object_class_install_property (object_class,
386 g_param_spec_int ("status",
388 "The status of the print backend",
389 GTK_PRINT_BACKEND_STATUS_UNKNOWN,
390 GTK_PRINT_BACKEND_STATUS_UNAVAILABLE,
391 GTK_PRINT_BACKEND_STATUS_UNKNOWN,
392 GTK_PARAM_READWRITE));
394 g_type_class_add_private (class, sizeof (GtkPrintBackendPrivate));
396 signals[PRINTER_LIST_CHANGED] =
397 g_signal_new (I_("printer-list-changed"),
398 G_TYPE_FROM_CLASS (class),
400 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_list_changed),
402 g_cclosure_marshal_VOID__VOID,
404 signals[PRINTER_LIST_DONE] =
405 g_signal_new (I_("printer-list-done"),
406 G_TYPE_FROM_CLASS (class),
408 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_list_done),
410 g_cclosure_marshal_VOID__VOID,
412 signals[PRINTER_ADDED] =
413 g_signal_new (I_("printer-added"),
414 G_TYPE_FROM_CLASS (class),
416 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_added),
418 g_cclosure_marshal_VOID__OBJECT,
419 G_TYPE_NONE, 1, GTK_TYPE_PRINTER);
420 signals[PRINTER_REMOVED] =
421 g_signal_new (I_("printer-removed"),
422 G_TYPE_FROM_CLASS (class),
424 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_removed),
426 g_cclosure_marshal_VOID__OBJECT,
427 G_TYPE_NONE, 1, GTK_TYPE_PRINTER);
428 signals[PRINTER_STATUS_CHANGED] =
429 g_signal_new (I_("printer-status-changed"),
430 G_TYPE_FROM_CLASS (class),
432 G_STRUCT_OFFSET (GtkPrintBackendClass, printer_status_changed),
434 g_cclosure_marshal_VOID__OBJECT,
435 G_TYPE_NONE, 1, GTK_TYPE_PRINTER);
436 signals[REQUEST_PASSWORD] =
437 g_signal_new (I_("request-password"),
438 G_TYPE_FROM_CLASS (class),
440 G_STRUCT_OFFSET (GtkPrintBackendClass, request_password),
442 _gtk_marshal_VOID__POINTER_POINTER_POINTER_POINTER_STRING,
443 G_TYPE_NONE, 5, G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_STRING);
447 gtk_print_backend_init (GtkPrintBackend *backend)
449 GtkPrintBackendPrivate *priv;
451 priv = backend->priv = G_TYPE_INSTANCE_GET_PRIVATE (backend,
452 GTK_TYPE_PRINT_BACKEND,
453 GtkPrintBackendPrivate);
455 priv->printers = g_hash_table_new_full (g_str_hash, g_str_equal,
456 (GDestroyNotify) g_free,
457 (GDestroyNotify) g_object_unref);
458 priv->auth_info_required = NULL;
459 priv->auth_info = NULL;
463 gtk_print_backend_dispose (GObject *object)
465 GtkPrintBackend *backend;
466 GtkPrintBackendPrivate *priv;
468 backend = GTK_PRINT_BACKEND (object);
469 priv = backend->priv;
471 /* We unref the printers in dispose, not in finalize so that
472 * we can break refcount cycles with gtk_print_backend_destroy
476 g_hash_table_destroy (priv->printers);
477 priv->printers = NULL;
480 backend_parent_class->dispose (object);
485 fallback_printer_request_details (GtkPrinter *printer)
490 fallback_printer_mark_conflicts (GtkPrinter *printer,
491 GtkPrinterOptionSet *options)
497 fallback_printer_get_hard_margins (GtkPrinter *printer,
507 fallback_printer_list_papers (GtkPrinter *printer)
512 static GtkPageSetup *
513 fallback_printer_get_default_page_size (GtkPrinter *printer)
518 static GtkPrintCapabilities
519 fallback_printer_get_capabilities (GtkPrinter *printer)
526 printer_hash_to_sorted_active_list (const gchar *key,
532 printer = GTK_PRINTER (value);
534 if (gtk_printer_get_name (printer) == NULL)
537 if (!gtk_printer_is_active (printer))
540 *out_list = g_list_insert_sorted (*out_list, value, (GCompareFunc) gtk_printer_compare);
545 gtk_print_backend_add_printer (GtkPrintBackend *backend,
548 GtkPrintBackendPrivate *priv;
550 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
552 priv = backend->priv;
557 g_hash_table_insert (priv->printers,
558 g_strdup (gtk_printer_get_name (printer)),
559 g_object_ref (printer));
563 gtk_print_backend_remove_printer (GtkPrintBackend *backend,
566 GtkPrintBackendPrivate *priv;
568 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
569 priv = backend->priv;
574 g_hash_table_remove (priv->printers,
575 gtk_printer_get_name (printer));
579 gtk_print_backend_set_list_done (GtkPrintBackend *backend)
581 if (!backend->priv->printer_list_done)
583 backend->priv->printer_list_done = TRUE;
584 g_signal_emit (backend, signals[PRINTER_LIST_DONE], 0);
590 * gtk_print_backend_get_printer_list:
592 * Returns the current list of printers.
594 * Return value: (element-type GtkPrinter) (transfer container):
595 * A list of #GtkPrinter objects. The list should be freed
596 * with g_list_free().
599 gtk_print_backend_get_printer_list (GtkPrintBackend *backend)
601 GtkPrintBackendPrivate *priv;
604 g_return_val_if_fail (GTK_IS_PRINT_BACKEND (backend), NULL);
606 priv = backend->priv;
609 if (priv->printers != NULL)
610 g_hash_table_foreach (priv->printers,
611 (GHFunc) printer_hash_to_sorted_active_list,
614 if (!priv->printer_list_requested && priv->printers != NULL)
616 if (GTK_PRINT_BACKEND_GET_CLASS (backend)->request_printer_list)
617 GTK_PRINT_BACKEND_GET_CLASS (backend)->request_printer_list (backend);
618 priv->printer_list_requested = TRUE;
625 gtk_print_backend_printer_list_is_done (GtkPrintBackend *print_backend)
627 g_return_val_if_fail (GTK_IS_PRINT_BACKEND (print_backend), TRUE);
629 return print_backend->priv->printer_list_done;
633 gtk_print_backend_find_printer (GtkPrintBackend *backend,
634 const gchar *printer_name)
636 GtkPrintBackendPrivate *priv;
639 g_return_val_if_fail (GTK_IS_PRINT_BACKEND (backend), NULL);
641 priv = backend->priv;
644 printer = g_hash_table_lookup (priv->printers, printer_name);
652 gtk_print_backend_print_stream (GtkPrintBackend *backend,
655 GtkPrintJobCompleteFunc callback,
657 GDestroyNotify dnotify)
659 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
661 GTK_PRINT_BACKEND_GET_CLASS (backend)->print_stream (backend,
670 gtk_print_backend_set_password (GtkPrintBackend *backend,
671 gchar **auth_info_required,
674 g_return_if_fail (GTK_IS_PRINT_BACKEND (backend));
676 if (GTK_PRINT_BACKEND_GET_CLASS (backend)->set_password)
677 GTK_PRINT_BACKEND_GET_CLASS (backend)->set_password (backend, auth_info_required, auth_info);
681 store_entry (GtkEntry *entry,
684 gchar **data = (gchar **) user_data;
688 memset (*data, 0, strlen (*data));
692 *data = g_strdup (gtk_entry_get_text (entry));
696 password_dialog_response (GtkWidget *dialog,
698 GtkPrintBackend *backend)
700 GtkPrintBackendPrivate *priv = backend->priv;
703 if (response_id == GTK_RESPONSE_OK)
704 gtk_print_backend_set_password (backend, priv->auth_info_required, priv->auth_info);
706 gtk_print_backend_set_password (backend, priv->auth_info_required, NULL);
708 for (i = 0; i < g_strv_length (priv->auth_info_required); i++)
709 if (priv->auth_info[i] != NULL)
711 memset (priv->auth_info[i], 0, strlen (priv->auth_info[i]));
712 g_free (priv->auth_info[i]);
713 priv->auth_info[i] = NULL;
715 g_free (priv->auth_info);
716 priv->auth_info = NULL;
718 g_strfreev (priv->auth_info_required);
720 gtk_widget_destroy (dialog);
722 g_object_unref (backend);
726 request_password (GtkPrintBackend *backend,
727 gpointer auth_info_required,
728 gpointer auth_info_default,
729 gpointer auth_info_display,
730 gpointer auth_info_visible,
733 GtkPrintBackendPrivate *priv = backend->priv;
734 GtkWidget *dialog, *box, *main_box, *label, *icon, *vbox, *entry;
735 GtkWidget *focus = NULL;
736 GtkWidget *content_area;
740 gchar **ai_required = (gchar **) auth_info_required;
741 gchar **ai_default = (gchar **) auth_info_default;
742 gchar **ai_display = (gchar **) auth_info_display;
743 gboolean *ai_visible = (gboolean *) auth_info_visible;
745 priv->auth_info_required = g_strdupv (ai_required);
746 length = g_strv_length (ai_required);
747 priv->auth_info = g_new0 (gchar *, length);
749 dialog = gtk_dialog_new_with_buttons ( _("Authentication"), NULL, GTK_DIALOG_MODAL,
750 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
751 GTK_STOCK_OK, GTK_RESPONSE_OK,
754 gtk_dialog_set_default_response (GTK_DIALOG (dialog), GTK_RESPONSE_OK);
756 main_box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
759 icon = gtk_image_new_from_stock (GTK_STOCK_DIALOG_AUTHENTICATION, GTK_ICON_SIZE_DIALOG);
760 gtk_misc_set_alignment (GTK_MISC (icon), 0.5, 0.0);
761 gtk_misc_set_padding (GTK_MISC (icon), 6, 6);
765 vbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
766 gtk_widget_set_size_request (GTK_WIDGET (vbox), 320, -1);
769 label = gtk_label_new (NULL);
770 markup = g_markup_printf_escaped ("<span weight=\"bold\" size=\"large\">%s</span>", prompt);
771 gtk_label_set_markup (GTK_LABEL (label), markup);
772 gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
773 gtk_widget_set_size_request (GTK_WIDGET (label), 320, -1);
778 content_area = gtk_dialog_get_content_area (GTK_DIALOG (dialog));
779 gtk_box_pack_start (GTK_BOX (content_area), main_box, TRUE, FALSE, 0);
781 gtk_box_pack_start (GTK_BOX (main_box), icon, FALSE, FALSE, 6);
782 gtk_box_pack_start (GTK_BOX (main_box), vbox, FALSE, FALSE, 6);
784 gtk_box_pack_start (GTK_BOX (vbox), label, FALSE, TRUE, 6);
787 for (i = 0; i < length; i++)
789 priv->auth_info[i] = g_strdup (ai_default[i]);
790 if (ai_display[i] != NULL)
792 box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
793 gtk_box_set_homogeneous (GTK_BOX (box), TRUE);
795 label = gtk_label_new (ai_display[i]);
796 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
798 entry = gtk_entry_new ();
801 if (ai_default[i] != NULL)
802 gtk_entry_set_text (GTK_ENTRY (entry), ai_default[i]);
804 gtk_entry_set_visibility (GTK_ENTRY (entry), ai_visible[i]);
805 gtk_entry_set_activates_default (GTK_ENTRY (entry), TRUE);
807 gtk_box_pack_start (GTK_BOX (vbox), box, FALSE, TRUE, 6);
809 gtk_box_pack_start (GTK_BOX (box), label, TRUE, TRUE, 0);
810 gtk_box_pack_start (GTK_BOX (box), entry, TRUE, TRUE, 0);
812 g_signal_connect (entry, "changed",
813 G_CALLBACK (store_entry), &(priv->auth_info[i]));
819 gtk_widget_grab_focus (focus);
823 g_object_ref (backend);
824 g_signal_connect (G_OBJECT (dialog), "response",
825 G_CALLBACK (password_dialog_response), backend);
827 gtk_widget_show_all (dialog);
831 gtk_print_backend_destroy (GtkPrintBackend *print_backend)
833 /* The lifecycle of print backends and printers are tied, such that
834 * the backend owns the printers, but the printers also ref the backend.
835 * This is so that if the app has a reference to a printer its backend
836 * will be around. However, this results in a cycle, which we break
837 * with this call, which causes the print backend to release its printers.
839 g_object_run_dispose (G_OBJECT (print_backend));