libdocument/ev-document-factory.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; c-indent-level: 8 -*- */
   2 /*
   3  *  Copyright (C) 2005, Red Hat, Inc.
   4  *
   5  *  This program is free software; you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation; either version 2, or (at your option)
   8  *  any later version.
   9  *
  10  *  This program 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
  13  *  GNU General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with this program; if not, write to the Free Software
  17  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  *
  19  */
  20
  21 #ifdef HAVE_CONFIG_H
  22 #include "config.h"
  23 #endif
  24
  25 #include <string.h>
  26
  27 #include <gio/gio.h>
  28 #include <glib/gstdio.h>
  29 #include <glib/gi18n-lib.h>
  30 #include <gtk/gtk.h>
  31
  32 #include "ev-backends-manager.h"
  33 #include "ev-document-factory.h"
  34 #include "ev-file-helpers.h"
  35
  36 static EvCompressionType
  37 get_compression_from_mime_type (const gchar *mime_type)
  38 {
  39         gchar type[3];
  40         gchar *p;
  41
  42         if (!(p = g_strrstr (mime_type, "/")))
  43                 return EV_COMPRESSION_NONE;
  44
  45         if (sscanf (++p, "x-%2s%*s", type) == 1) {
  46                 if (g_ascii_strcasecmp (type, "gz") == 0)
  47                         return EV_COMPRESSION_GZIP;
  48                 else if (g_ascii_strcasecmp (type, "bz") == 0)
  49                         return EV_COMPRESSION_BZIP2;
  50         }
  51
  52         return EV_COMPRESSION_NONE;
  53 }
  54
  55
  56 /*
  57  * get_document_from_uri:
  58  * @uri: the document URI
  59  * @fast: whether to use fast MIME type detection
  60  * @compression: a location to store the document's compression type
  61  * @error: a #GError location to store an error, or %NULL
  62  *
  63  * Creates a #EvDocument instance for the document at @uri, using either
  64  * fast or slow MIME type detection. If a document could be created,
  65  * @compression is filled in with the document's compression type.
  66  * On error, %NULL is returned and @error filled in.
  67  *
  68  * Returns: a new #EvDocument instance, or %NULL on error with @error filled in
  69  */
  70 static EvDocument *
  71 get_document_from_uri (const char        *uri,
  72                        gboolean           fast,
  73                        EvCompressionType *compression,
  74                        GError           **error)
  75 {
  76         EvDocument *document = NULL;
  77         gchar      *mime_type = NULL;
  78         GError     *err = NULL;
  79
  80         *compression = EV_COMPRESSION_NONE;
  81
  82         mime_type = ev_file_get_mime_type (uri, fast, &err);
  83
  84         if (mime_type == NULL) {
  85                 g_free (mime_type);
  86
  87                 if (err == NULL) {
  88                         g_set_error_literal (error,
  89                                              EV_DOCUMENT_ERROR,
  90                                              EV_DOCUMENT_ERROR_INVALID,
  91                                              _("Unknown MIME Type"));
  92                 } else {
  93                         g_propagate_error (error, err);
  94                 }
  95
  96                 return NULL;
  97         }
  98
  99         document = ev_backends_manager_get_document (mime_type);
 100         if (document == NULL) {
 101                 gchar *content_type, *mime_desc = NULL;
 102
 103                 content_type = g_content_type_from_mime_type (mime_type);
 104                 if (content_type)
 105                         mime_desc = g_content_type_get_description (content_type);
 106
 107                 g_set_error (error,
 108                              EV_DOCUMENT_ERROR,
 109                              EV_DOCUMENT_ERROR_INVALID,
 110                              _("File type %s (%s) is not supported"),
 111                              mime_desc ? mime_desc : "-", mime_type);
 112                 g_free (mime_desc);
 113                 g_free (content_type);
 114                 g_free (mime_type);
 115
 116                 return NULL;
 117         }
 118
 119         *compression = get_compression_from_mime_type (mime_type);
 120
 121         g_free (mime_type);
 122
 123         return document;
 124 }
 125
 126 static void
 127 free_uncompressed_uri (gchar *uri_unc)
 128 {
 129         if (!uri_unc)
 130                 return;
 131
 132         ev_tmp_uri_unlink (uri_unc);
 133         g_free (uri_unc);
 134 }
 135
 136 /**
 137  * ev_document_factory_get_document:
 138  * @uri: an URI
 139  * @error: a #GError location to store an error, or %NULL
 140  *
 141  * Creates a #EvDocument for the document at @uri; or, if no backend handling
 142  * the document's type is found, or an error occurred on opening the document,
 143  * returns %NULL and fills in @error.
 144  * If the document is encrypted, it is returned but also @error is set to
 145  * %EV_DOCUMENT_ERROR_ENCRYPTED.
 146  *
 147  * Returns: a new #EvDocument, or %NULL.
 148  */
 149 EvDocument *
 150 ev_document_factory_get_document (const char *uri, GError **error)
 151 {
 152         EvDocument *document;
 153         int result;
 154         EvCompressionType compression;
 155         gchar *uri_unc = NULL;
 156         GError *err = NULL;
 157
 158         g_return_val_if_fail (uri != NULL, NULL);
 159
 160         document = get_document_from_uri (uri, TRUE, &compression, &err);
 161         g_assert (document != NULL || err != NULL);
 162
 163         if (document != NULL) {
 164                 uri_unc = ev_file_uncompress (uri, compression, &err);
 165                 if (uri_unc) {
 166                         g_object_set_data_full (G_OBJECT (document),
 167                                                 "uri-uncompressed",
 168                                                 uri_unc,
 169                                                 (GDestroyNotify) free_uncompressed_uri);
 170                 } else if (err != NULL) {
 171                         /* Error uncompressing file */
 172                         g_object_unref (document);
 173                         g_propagate_error (error, err);
 174                         return NULL;
 175                 }
 176
 177                 result = ev_document_load (document, uri_unc ? uri_unc : uri, &err);
 178
 179                 if (result == FALSE || err) {
 180                         if (err &&
 181                             g_error_matches (err, EV_DOCUMENT_ERROR, EV_DOCUMENT_ERROR_ENCRYPTED)) {
 182                                 g_propagate_error (error, err);
 183                                 return document;
 184                             }
 185                         /* else fall through to slow mime code section below */
 186                 } else {
 187                         return document;
 188                 }
 189
 190                 g_object_unref (document);
 191                 document = NULL;
 192         }
 193
 194         /* Try again with slow mime detection */
 195         g_clear_error (&err);
 196         uri_unc = NULL;
 197
 198         document = get_document_from_uri (uri, FALSE, &compression, &err);
 199         if (document == NULL) {
 200                 g_assert (err != NULL);
 201                 g_propagate_error (error, err);
 202                 return NULL;
 203         }
 204
 205         uri_unc = ev_file_uncompress (uri, compression, &err);
 206         if (uri_unc) {
 207                 g_object_set_data_full (G_OBJECT (document),
 208                                         "uri-uncompressed",
 209                                         uri_unc,
 210                                         (GDestroyNotify) free_uncompressed_uri);
 211         } else if (err != NULL) {
 212                 /* Error uncompressing file */
 213                 g_propagate_error (error, err);
 214
 215                 g_object_unref (document);
 216                 return NULL;
 217         }
 218
 219         result = ev_document_load (document, uri_unc ? uri_unc : uri, &err);
 220         if (result == FALSE) {
 221                 if (err == NULL) {
 222                         /* FIXME: this really should not happen; the backend should
 223                          * always return a meaningful error.
 224                          */
 225                         g_set_error_literal (&err,
 226                                              EV_DOCUMENT_ERROR,
 227                                              EV_DOCUMENT_ERROR_INVALID,
 228                                              _("Unknown MIME Type"));
 229                 } else if (g_error_matches (err, EV_DOCUMENT_ERROR, EV_DOCUMENT_ERROR_ENCRYPTED)) {
 230                         g_propagate_error (error, err);
 231                         return document;
 232                 }
 233
 234                 g_object_unref (document);
 235                 document = NULL;
 236
 237                 g_propagate_error (error, err);
 238         }
 239
 240         return document;
 241 }
 242
 243 static void
 244 file_filter_add_mime_types (EvTypeInfo *info, GtkFileFilter *filter)
 245 {
 246         const gchar *mime_type;
 247         gint         i = 0;
 248
 249         while ((mime_type = info->mime_types[i++]))
 250                 gtk_file_filter_add_mime_type (filter, mime_type);
 251 }
 252
 253 /**
 254  * ev_document_factory_add_filters:
 255  * @chooser: a #GtkFileChooser
 256  * @document: a #EvDocument, or %NULL
 257  *
 258  * Adds some file filters to @chooser.
 259
 260  * Always add a "All documents" format.
 261  *
 262  * If @document is not %NULL, adds a #GtkFileFilter for @document's MIME type.
 263  *
 264  * If @document is %NULL, adds a #GtkFileFilter for each document type that evince
 265  * can handle.
 266  */
 267 void
 268 ev_document_factory_add_filters (GtkWidget *chooser, EvDocument *document)
 269 {
 270         GList         *all_types;
 271         GtkFileFilter *filter;
 272         GtkFileFilter *default_filter;
 273         GtkFileFilter *document_filter;
 274
 275         g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
 276         g_return_if_fail (document == NULL || EV_IS_DOCUMENT (document));
 277
 278         all_types = ev_backends_manager_get_all_types_info ();
 279
 280         default_filter = document_filter = filter = gtk_file_filter_new ();
 281         gtk_file_filter_set_name (filter, _("All Documents"));
 282         g_list_foreach (all_types, (GFunc)file_filter_add_mime_types, filter);
 283         gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), filter);
 284
 285         if (document) {
 286                 EvTypeInfo *info;
 287
 288                 info = ev_backends_manager_get_document_type_info (document);
 289                 default_filter = filter = gtk_file_filter_new ();
 290                 gtk_file_filter_set_name (filter, info->desc);
 291                 file_filter_add_mime_types (info, filter);
 292                 g_free (info);
 293                 gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), filter);
 294         } else {
 295                 GList *l;
 296
 297                 for (l = all_types; l; l = g_list_next (l)){
 298                         EvTypeInfo *info;
 299
 300                         info = (EvTypeInfo *)l->data;
 301
 302                         default_filter = filter = gtk_file_filter_new ();
 303                         gtk_file_filter_set_name (filter, info->desc);
 304                         file_filter_add_mime_types (info, filter);
 305                         gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), filter);
 306                 }
 307         }
 308
 309         g_list_foreach (all_types, (GFunc)g_free, NULL);
 310         g_list_free (all_types);
 311
 312         filter = gtk_file_filter_new ();
 313         gtk_file_filter_set_name (filter, _("All Files"));
 314         gtk_file_filter_add_pattern (filter, "*");
 315         gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), filter);
 316
 317         gtk_file_chooser_set_filter (GTK_FILE_CHOOSER (chooser),
 318                                      document == NULL ? document_filter : default_filter);
 319 }