]> Pileus Git - ~andy/gtk/blob - modules/printbackends/file/gtkprintbackendfile.c
Bug 344522 – support non-local destination files (GtkPrint):
[~andy/gtk] / modules / printbackends / file / gtkprintbackendfile.c
1 /* GTK - The GIMP Toolkit
2  * gtkprintbackendfile.c: Default implementation of GtkPrintBackend 
3  * for printing to a file
4  * Copyright (C) 2003, Red Hat, Inc.
5  *
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.
10  *
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.
15  *
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.
20  */
21
22 #include "config.h"
23
24 #include <unistd.h>
25 #include <sys/types.h>
26 #include <sys/stat.h>
27 #include <fcntl.h>
28 #include <stdlib.h>
29 #include <string.h>
30
31 #include <errno.h>
32 #include <cairo.h>
33 #include <cairo-pdf.h>
34 #include <cairo-ps.h>
35
36 #include <glib/gi18n-lib.h>
37
38 #include "gtk/gtk.h"
39 #include "gtk/gtkprinter-private.h"
40
41 #include "gtkprintbackendfile.h"
42
43 typedef struct _GtkPrintBackendFileClass GtkPrintBackendFileClass;
44
45 #define GTK_PRINT_BACKEND_FILE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_BACKEND_FILE, GtkPrintBackendFileClass))
46 #define GTK_IS_PRINT_BACKEND_FILE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_BACKEND_FILE))
47 #define GTK_PRINT_BACKEND_FILE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_BACKEND_FILE, GtkPrintBackendFileClass))
48
49 #define _STREAM_MAX_CHUNK_SIZE 8192
50
51 static GType print_backend_file_type = 0;
52
53 struct _GtkPrintBackendFileClass
54 {
55   GtkPrintBackendClass parent_class;
56 };
57
58 struct _GtkPrintBackendFile
59 {
60   GtkPrintBackend parent_instance;
61 };
62
63 typedef enum
64 {
65   FORMAT_PDF,
66   FORMAT_PS,
67   N_FORMATS
68 } OutputFormat;
69
70 static const gchar* formats[N_FORMATS] =
71 {
72   "pdf",
73   "ps"
74 };
75
76 static GObjectClass *backend_parent_class;
77
78 static void                 gtk_print_backend_file_class_init      (GtkPrintBackendFileClass *class);
79 static void                 gtk_print_backend_file_init            (GtkPrintBackendFile      *impl);
80 static void                 file_printer_get_settings_from_options (GtkPrinter              *printer,
81                                                                     GtkPrinterOptionSet     *options,
82                                                                     GtkPrintSettings        *settings);
83 static GtkPrinterOptionSet *file_printer_get_options               (GtkPrinter              *printer,
84                                                                     GtkPrintSettings        *settings,
85                                                                     GtkPageSetup            *page_setup,
86                                                                     GtkPrintCapabilities     capabilities);
87 static void                 file_printer_prepare_for_print         (GtkPrinter              *printer,
88                                                                     GtkPrintJob             *print_job,
89                                                                     GtkPrintSettings        *settings,
90                                                                     GtkPageSetup            *page_setup);
91 static void                 gtk_print_backend_file_print_stream    (GtkPrintBackend         *print_backend,
92                                                                     GtkPrintJob             *job,
93                                                                     GIOChannel              *data_io,
94                                                                     GtkPrintJobCompleteFunc  callback,
95                                                                     gpointer                 user_data,
96                                                                     GDestroyNotify           dnotify);
97 static cairo_surface_t *    file_printer_create_cairo_surface      (GtkPrinter              *printer,
98                                                                     GtkPrintSettings        *settings,
99                                                                     gdouble                  width,
100                                                                     gdouble                  height,
101                                                                     GIOChannel              *cache_io);
102
103 static GList *              file_printer_list_papers               (GtkPrinter              *printer);
104 static GtkPageSetup *       file_printer_get_default_page_size     (GtkPrinter              *printer);
105
106 static void
107 gtk_print_backend_file_register_type (GTypeModule *module)
108 {
109   static const GTypeInfo print_backend_file_info =
110   {
111     sizeof (GtkPrintBackendFileClass),
112     NULL,               /* base_init */
113     NULL,               /* base_finalize */
114     (GClassInitFunc) gtk_print_backend_file_class_init,
115     NULL,               /* class_finalize */
116     NULL,               /* class_data */
117     sizeof (GtkPrintBackendFile),
118     0,          /* n_preallocs */
119     (GInstanceInitFunc) gtk_print_backend_file_init,
120   };
121
122   print_backend_file_type = g_type_module_register_type (module,
123                                                          GTK_TYPE_PRINT_BACKEND,
124                                                          "GtkPrintBackendFile",
125                                                          &print_backend_file_info, 0);
126 }
127
128 G_MODULE_EXPORT void 
129 pb_module_init (GTypeModule *module)
130 {
131   gtk_print_backend_file_register_type (module);
132 }
133
134 G_MODULE_EXPORT void 
135 pb_module_exit (void)
136 {
137
138 }
139   
140 G_MODULE_EXPORT GtkPrintBackend * 
141 pb_module_create (void)
142 {
143   return gtk_print_backend_file_new ();
144 }
145
146 /*
147  * GtkPrintBackendFile
148  */
149 GType
150 gtk_print_backend_file_get_type (void)
151 {
152   return print_backend_file_type;
153 }
154
155 /**
156  * gtk_print_backend_file_new:
157  *
158  * Creates a new #GtkPrintBackendFile object. #GtkPrintBackendFile
159  * implements the #GtkPrintBackend interface with direct access to
160  * the filesystem using Unix/Linux API calls
161  *
162  * Return value: the new #GtkPrintBackendFile object
163  **/
164 GtkPrintBackend *
165 gtk_print_backend_file_new (void)
166 {
167   return g_object_new (GTK_TYPE_PRINT_BACKEND_FILE, NULL);
168 }
169
170 static void
171 gtk_print_backend_file_class_init (GtkPrintBackendFileClass *class)
172 {
173   GtkPrintBackendClass *backend_class = GTK_PRINT_BACKEND_CLASS (class);
174
175   backend_parent_class = g_type_class_peek_parent (class);
176
177   backend_class->print_stream = gtk_print_backend_file_print_stream;
178   backend_class->printer_create_cairo_surface = file_printer_create_cairo_surface;
179   backend_class->printer_get_options = file_printer_get_options;
180   backend_class->printer_get_settings_from_options = file_printer_get_settings_from_options;
181   backend_class->printer_prepare_for_print = file_printer_prepare_for_print;
182   backend_class->printer_list_papers = file_printer_list_papers;
183   backend_class->printer_get_default_page_size = file_printer_get_default_page_size;
184 }
185
186 /* return N_FORMATS if no explicit format in the settings */
187 static OutputFormat
188 format_from_settings (GtkPrintSettings *settings)
189 {
190   const gchar *value;
191   gint i;
192
193   if (settings == NULL)
194     return N_FORMATS;
195
196   value = gtk_print_settings_get (settings,
197                                   GTK_PRINT_SETTINGS_OUTPUT_FILE_FORMAT);
198   if (value == NULL)
199     return N_FORMATS;
200
201   for (i = 0; i < N_FORMATS; ++i)
202     if (strcmp (value, formats[i]) == 0)
203       break;
204
205   g_assert (i < N_FORMATS);
206
207   return (OutputFormat) i;
208 }
209
210 static gchar *
211 output_file_from_settings (GtkPrintSettings *settings,
212                            const gchar      *default_format)
213 {
214   gchar *uri = NULL;
215   
216   if (settings)
217     uri = g_strdup (gtk_print_settings_get (settings, GTK_PRINT_SETTINGS_OUTPUT_URI));
218
219   if (uri == NULL)
220     { 
221       const gchar *extension;
222       gchar *name, *locale_name, *path;
223
224       if (default_format)
225         extension = default_format;
226       else
227         {
228           OutputFormat format;
229
230           format = format_from_settings (settings);
231           extension = format == FORMAT_PS ? "ps" : "pdf";
232         }
233  
234       /* default filename used for print-to-file */ 
235       name = g_strdup_printf (_("output.%s"), extension);
236       locale_name = g_filename_from_utf8 (name, -1, NULL, NULL, NULL);
237       g_free (name);
238
239       if (locale_name != NULL)
240         {
241           gchar *current_dir = g_get_current_dir ();
242           path = g_build_filename (current_dir, locale_name, NULL);
243           g_free (locale_name);
244
245           uri = g_filename_to_uri (path, NULL, NULL);
246           g_free (path);
247           g_free (current_dir);
248         }
249     }
250
251   return uri;
252 }
253
254 static cairo_status_t
255 _cairo_write (void                *closure,
256               const unsigned char *data,
257               unsigned int         length)
258 {
259   GIOChannel *io = (GIOChannel *)closure;
260   gsize written;
261   GError *error;
262
263   error = NULL;
264
265   GTK_NOTE (PRINTING,
266             g_print ("FILE Backend: Writting %i byte chunk to temp file\n", length));
267
268   while (length > 0) 
269     {
270       g_io_channel_write_chars (io, (const gchar *) data, length, &written, &error);
271
272       if (error != NULL)
273         {
274           GTK_NOTE (PRINTING,
275                      g_print ("FILE Backend: Error writting to temp file, %s\n", error->message));
276
277           g_error_free (error);
278           return CAIRO_STATUS_WRITE_ERROR;
279         }    
280
281       GTK_NOTE (PRINTING,
282                 g_print ("FILE Backend: Wrote %i bytes to temp file\n", written));
283       
284       data += written;
285       length -= written;
286     }
287
288   return CAIRO_STATUS_SUCCESS;
289 }
290
291
292 static cairo_surface_t *
293 file_printer_create_cairo_surface (GtkPrinter       *printer,
294                                    GtkPrintSettings *settings,
295                                    gdouble           width, 
296                                    gdouble           height,
297                                    GIOChannel       *cache_io)
298 {
299   cairo_surface_t *surface;
300   OutputFormat format;
301
302   format = format_from_settings (settings);
303
304   if (format == FORMAT_PS)
305     surface = cairo_ps_surface_create_for_stream (_cairo_write, cache_io, width, height);
306   else
307     surface = cairo_pdf_surface_create_for_stream (_cairo_write, cache_io, width, height);
308
309   /* TODO: DPI from settings object? */
310   cairo_surface_set_fallback_resolution (surface, 300, 300);
311
312   return surface;
313 }
314
315 typedef struct {
316   GtkPrintBackend *backend;
317   GtkPrintJobCompleteFunc callback;
318   GtkPrintJob *job;
319   GFileOutputStream *target_io_stream;
320   gpointer user_data;
321   GDestroyNotify dnotify;
322 } _PrintStreamData;
323
324 static void
325 file_print_cb (GtkPrintBackendFile *print_backend,
326                GError              *error,
327                gpointer            user_data)
328 {
329   _PrintStreamData *ps = (_PrintStreamData *) user_data;
330
331   GDK_THREADS_ENTER ();
332
333   if (ps->target_io_stream != NULL)
334     g_output_stream_close (G_OUTPUT_STREAM (ps->target_io_stream), NULL, NULL);
335
336   if (ps->callback)
337     ps->callback (ps->job, ps->user_data, error);
338
339   if (ps->dnotify)
340     ps->dnotify (ps->user_data);
341
342   gtk_print_job_set_status (ps->job,
343                             (error != NULL)?GTK_PRINT_STATUS_FINISHED_ABORTED:GTK_PRINT_STATUS_FINISHED);
344
345   if (ps->job)
346     g_object_unref (ps->job);
347  
348   g_free (ps);
349
350   GDK_THREADS_LEAVE ();
351 }
352
353 static gboolean
354 file_write (GIOChannel   *source,
355             GIOCondition  con,
356             gpointer      user_data)
357 {
358   gchar buf[_STREAM_MAX_CHUNK_SIZE];
359   gsize bytes_read;
360   GError *error;
361   GIOStatus read_status;
362   _PrintStreamData *ps = (_PrintStreamData *) user_data;
363
364   error = NULL;
365
366   read_status = 
367     g_io_channel_read_chars (source,
368                              buf,
369                              _STREAM_MAX_CHUNK_SIZE,
370                              &bytes_read,
371                              &error);
372
373   if (read_status != G_IO_STATUS_ERROR)
374     {
375       gsize bytes_written;
376
377       g_output_stream_write_all (G_OUTPUT_STREAM (ps->target_io_stream),
378                                  buf,
379                                  bytes_read,
380                                  &bytes_written,
381                                  NULL,
382                                  &error);
383     }
384
385   if (error != NULL || read_status == G_IO_STATUS_EOF)
386     {
387       file_print_cb (GTK_PRINT_BACKEND_FILE (ps->backend), error, user_data);
388
389       if (error != NULL)
390         {
391           GTK_NOTE (PRINTING,
392                     g_print ("FILE Backend: %s\n", error->message));
393
394           g_error_free (error);
395         }
396
397       return FALSE;
398     }
399
400   GTK_NOTE (PRINTING,
401             g_print ("FILE Backend: Writting %i byte chunk to target file\n", bytes_read));
402
403   return TRUE;
404 }
405
406 static void
407 gtk_print_backend_file_print_stream (GtkPrintBackend        *print_backend,
408                                      GtkPrintJob            *job,
409                                      GIOChannel             *data_io,
410                                      GtkPrintJobCompleteFunc callback,
411                                      gpointer                user_data,
412                                      GDestroyNotify          dnotify)
413 {
414   GError *internal_error = NULL;
415   GtkPrinter *printer;
416   _PrintStreamData *ps;
417   GtkPrintSettings *settings;
418   gchar *uri;
419   GFile *file = NULL;
420
421   printer = gtk_print_job_get_printer (job);
422   settings = gtk_print_job_get_settings (job);
423
424   ps = g_new0 (_PrintStreamData, 1);
425   ps->callback = callback;
426   ps->user_data = user_data;
427   ps->dnotify = dnotify;
428   ps->job = g_object_ref (job);
429   ps->backend = print_backend;
430
431   internal_error = NULL;
432   uri = output_file_from_settings (settings, NULL);
433
434   if (uri == NULL)
435     goto error;
436
437   file = g_file_new_for_uri (uri);
438   ps->target_io_stream = g_file_replace (file, NULL, FALSE, G_FILE_CREATE_NONE, NULL, &internal_error);
439
440   g_object_unref (file);
441   g_free (uri);
442
443 error:
444   if (internal_error != NULL)
445     {
446       file_print_cb (GTK_PRINT_BACKEND_FILE (print_backend),
447                     internal_error, ps);
448
449       g_error_free (internal_error);
450       return;
451     }
452
453   g_io_add_watch (data_io, 
454                   G_IO_IN | G_IO_PRI | G_IO_ERR | G_IO_HUP,
455                   (GIOFunc) file_write,
456                   ps);
457 }
458
459 static void
460 gtk_print_backend_file_init (GtkPrintBackendFile *backend)
461 {
462   GtkPrinter *printer;
463   
464   printer = g_object_new (GTK_TYPE_PRINTER,
465                           "name", _("Print to File"),
466                           "backend", backend,
467                           "is-virtual", TRUE,
468                           NULL); 
469
470   gtk_printer_set_has_details (printer, TRUE);
471   gtk_printer_set_icon_name (printer, "gtk-floppy");
472   gtk_printer_set_is_active (printer, TRUE);
473
474   gtk_print_backend_add_printer (GTK_PRINT_BACKEND (backend), printer);
475   g_object_unref (printer);
476
477   gtk_print_backend_set_list_done (GTK_PRINT_BACKEND (backend));
478 }
479
480 static void
481 file_printer_output_file_format_changed (GtkPrinterOption    *format_option,
482                                          GtkPrinterOptionSet *set)
483 {
484   GtkPrinterOption *uri_option;
485   gchar            *base = NULL;
486
487   if (! format_option->value)
488     return;
489
490   uri_option = gtk_printer_option_set_lookup (set,
491                                               "gtk-main-page-custom-input");
492
493   if (uri_option && uri_option->value)
494     {
495       const gchar *uri = uri_option->value;
496       const gchar *dot = strrchr (uri, '.');
497
498       if (dot)
499         {
500           gint i;
501
502           /*  check if the file extension matches one of the known ones  */
503           for (i = 0; i < N_FORMATS; i++)
504             if (strcmp (dot + 1, formats[i]) == 0)
505               break;
506
507           if (i < N_FORMATS && strcmp (formats[i], format_option->value))
508             {
509               /*  the file extension is known but doesn't match the
510                *  selected one, strip it away
511                */
512               base = g_strndup (uri, dot - uri);
513             }
514         }
515       else
516         {
517           /*  there's no file extension  */
518           base = g_strdup (uri);
519         }
520     }
521
522   if (base)
523     {
524       gchar *tmp = g_strdup_printf ("%s.%s", base, format_option->value);
525
526       gtk_printer_option_set (uri_option, tmp);
527       g_free (tmp);
528       g_free (base);
529     }
530 }
531
532 static GtkPrinterOptionSet *
533 file_printer_get_options (GtkPrinter           *printer,
534                           GtkPrintSettings     *settings,
535                           GtkPageSetup         *page_setup,
536                           GtkPrintCapabilities  capabilities)
537 {
538   GtkPrinterOptionSet *set;
539   GtkPrinterOption *option;
540   const gchar *n_up[] = {"1", "2", "4", "6", "9", "16" };
541   const gchar *pages_per_sheet = NULL;
542   const gchar *format_names[N_FORMATS] = { N_("PDF"), N_("Postscript") };
543   const gchar *supported_formats[N_FORMATS];
544   gchar *display_format_names[N_FORMATS];
545   gint n_formats = 0;
546   OutputFormat format;
547   gchar *uri;
548   gint current_format = 0;
549
550   format = format_from_settings (settings);
551
552   set = gtk_printer_option_set_new ();
553
554   option = gtk_printer_option_new ("gtk-n-up", _("Pages per _sheet:"), GTK_PRINTER_OPTION_TYPE_PICKONE);
555   gtk_printer_option_choices_from_array (option, G_N_ELEMENTS (n_up),
556                                          (char **) n_up, (char **) n_up /* FIXME i18n (localised digits)! */);
557   if (settings)
558     pages_per_sheet = gtk_print_settings_get (settings, GTK_PRINT_SETTINGS_NUMBER_UP);
559   if (pages_per_sheet)
560     gtk_printer_option_set (option, pages_per_sheet);
561   else
562     gtk_printer_option_set (option, "1");
563   gtk_printer_option_set_add (set, option);
564   g_object_unref (option);
565
566   if (capabilities & (GTK_PRINT_CAPABILITY_GENERATE_PDF | GTK_PRINT_CAPABILITY_GENERATE_PS))
567     {
568       if (capabilities & GTK_PRINT_CAPABILITY_GENERATE_PDF)
569         {
570           if (format == FORMAT_PDF || format == N_FORMATS)
571             {
572               format = FORMAT_PDF;
573               current_format = n_formats;
574             }
575           supported_formats[n_formats] = formats[FORMAT_PDF];
576           display_format_names[n_formats] = _(format_names[FORMAT_PDF]);
577           n_formats++;
578         }
579       if (capabilities & GTK_PRINT_CAPABILITY_GENERATE_PS)
580         {
581           if (format == FORMAT_PS || format == N_FORMATS)
582             current_format = n_formats;
583           supported_formats[n_formats] = formats[FORMAT_PS];
584           display_format_names[n_formats] = _(format_names[FORMAT_PS]);
585           n_formats++;
586         }
587     }
588   else
589     {
590       current_format = format == FORMAT_PS ? FORMAT_PS : FORMAT_PDF;
591       for (n_formats = 0; n_formats < N_FORMATS; ++n_formats)
592         {
593           supported_formats[n_formats] = formats[n_formats];
594           display_format_names[n_formats] = _(format_names[n_formats]);
595         }
596     }
597
598   uri = output_file_from_settings (settings, supported_formats[current_format]);
599
600   option = gtk_printer_option_new ("gtk-main-page-custom-input", _("File"), 
601                                    GTK_PRINTER_OPTION_TYPE_FILESAVE);
602   gtk_printer_option_set (option, uri);
603   g_free (uri);
604   option->group = g_strdup ("GtkPrintDialogExtension");
605   gtk_printer_option_set_add (set, option);
606
607   if (n_formats > 1)
608     {
609       option = gtk_printer_option_new ("output-file-format", _("_Output format"), 
610                                        GTK_PRINTER_OPTION_TYPE_ALTERNATIVE);
611       option->group = g_strdup ("GtkPrintDialogExtension");
612
613       gtk_printer_option_choices_from_array (option, n_formats,
614                                              (char **) supported_formats,
615                                              display_format_names);
616       gtk_printer_option_set (option, supported_formats[current_format]);
617       gtk_printer_option_set_add (set, option);
618
619       g_signal_connect (option, "changed",
620                         G_CALLBACK (file_printer_output_file_format_changed),
621                         set);
622
623       g_object_unref (option);
624     }
625
626   return set;
627 }
628
629 static void
630 file_printer_get_settings_from_options (GtkPrinter          *printer,
631                                         GtkPrinterOptionSet *options,
632                                         GtkPrintSettings    *settings)
633 {
634   GtkPrinterOption *option;
635
636   option = gtk_printer_option_set_lookup (options, "gtk-main-page-custom-input");
637   gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_OUTPUT_URI, option->value);
638
639   option = gtk_printer_option_set_lookup (options, "output-file-format");
640   if (option)
641     gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_OUTPUT_FILE_FORMAT, option->value);
642
643   option = gtk_printer_option_set_lookup (options, "gtk-n-up");
644   if (option)
645     gtk_print_settings_set (settings, GTK_PRINT_SETTINGS_NUMBER_UP, option->value);
646 }
647
648 static void
649 file_printer_prepare_for_print (GtkPrinter       *printer,
650                                 GtkPrintJob      *print_job,
651                                 GtkPrintSettings *settings,
652                                 GtkPageSetup     *page_setup)
653 {
654   gdouble scale;
655
656   print_job->print_pages = gtk_print_settings_get_print_pages (settings);
657   print_job->page_ranges = NULL;
658   print_job->num_page_ranges = 0;
659   
660   if (print_job->print_pages == GTK_PRINT_PAGES_RANGES)
661     print_job->page_ranges =
662       gtk_print_settings_get_page_ranges (settings,
663                                           &print_job->num_page_ranges);
664   
665   print_job->collate = gtk_print_settings_get_collate (settings);
666   print_job->reverse = gtk_print_settings_get_reverse (settings);
667   print_job->num_copies = gtk_print_settings_get_n_copies (settings);
668
669   scale = gtk_print_settings_get_scale (settings);
670   if (scale != 100.0)
671     print_job->scale = scale/100.0;
672
673   print_job->page_set = gtk_print_settings_get_page_set (settings);
674   print_job->rotate_to_orientation = TRUE;
675 }
676
677 static GList *
678 file_printer_list_papers (GtkPrinter *printer)
679 {
680   GList *result = NULL;
681   GList *papers, *p;
682   GtkPageSetup *page_setup;
683
684   papers = gtk_paper_size_get_paper_sizes (TRUE);
685
686   for (p = papers; p; p = p->next)
687     {
688       GtkPaperSize *paper_size = p->data;
689
690       page_setup = gtk_page_setup_new ();
691       gtk_page_setup_set_paper_size (page_setup, paper_size);
692       gtk_paper_size_free (paper_size);
693       result = g_list_prepend (result, page_setup);
694     }
695
696   g_list_free (papers);
697
698   return g_list_reverse (result);
699 }
700
701 static GtkPageSetup *
702 file_printer_get_default_page_size (GtkPrinter *printer)
703 {
704   GtkPageSetup *result = NULL;
705
706   return result;
707 }