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                 else if (g_ascii_strcasecmp (type, "xz") == 0)
  51                         return EV_COMPRESSION_LZMA;
  52         }
  53
  54         return EV_COMPRESSION_NONE;
  55 }
  56
  57
  58 /*
  59  * get_document_from_uri:
  60  * @uri: the document URI
  61  * @fast: whether to use fast MIME type detection
  62  * @compression: a location to store the document's compression type
  63  * @error: a #GError location to store an error, or %NULL
  64  *
  65  * Creates a #EvDocument instance for the document at @uri, using either
  66  * fast or slow MIME type detection. If a document could be created,
  67  * @compression is filled in with the document's compression type.
  68  * On error, %NULL is returned and @error filled in.
  69  *
  70  * Returns: a new #EvDocument instance, or %NULL on error with @error filled in
  71  */
  72 static EvDocument *
  73 get_document_from_uri (const char        *uri,
  74                        gboolean           fast,
  75                        EvCompressionType *compression,
  76                        GError           **error)
  77 {
  78         EvDocument *document = NULL;
  79         gchar      *mime_type = NULL;
  80         GError     *err = NULL;
  81
  82         *compression = EV_COMPRESSION_NONE;
  83
  84         mime_type = ev_file_get_mime_type (uri, fast, &err);
  85
  86         if (mime_type == NULL) {
  87                 g_free (mime_type);
  88
  89                 if (err == NULL) {
  90                         g_set_error_literal (error,
  91                                              EV_DOCUMENT_ERROR,
  92                                              EV_DOCUMENT_ERROR_INVALID,
  93                                              _("Unknown MIME Type"));
  94                 } else {
  95                         g_propagate_error (error, err);
  96                 }
  97
  98                 return NULL;
  99         }
 100
 101         document = ev_backends_manager_get_document (mime_type);
 102         if (document == NULL) {
 103                 gchar *content_type, *mime_desc = NULL;
 104
 105                 content_type = g_content_type_from_mime_type (mime_type);
 106                 if (content_type)
 107                         mime_desc = g_content_type_get_description (content_type);
 108
 109                 g_set_error (error,
 110                              EV_DOCUMENT_ERROR,
 111                              EV_DOCUMENT_ERROR_INVALID,
 112                              _("File type %s (%s) is not supported"),
 113                              mime_desc ? mime_desc : "-", mime_type);
 114                 g_free (mime_desc);
 115                 g_free (content_type);
 116                 g_free (mime_type);
 117
 118                 return NULL;
 119         }
 120
 121         *compression = get_compression_from_mime_type (mime_type);
 122
 123         g_free (mime_type);
 124
 125         return document;
 126 }
 127
 128 static void
 129 free_uncompressed_uri (gchar *uri_unc)
 130 {
 131         if (!uri_unc)
 132                 return;
 133
 134         ev_tmp_uri_unlink (uri_unc);
 135         g_free (uri_unc);
 136 }
 137
 138 /**
 139  * ev_document_factory_get_document:
 140  * @uri: an URI
 141  * @error: a #GError location to store an error, or %NULL
 142  *
 143  * Creates a #EvDocument for the document at @uri; or, if no backend handling
 144  * the document's type is found, or an error occurred on opening the document,
 145  * returns %NULL and fills in @error.
 146  * If the document is encrypted, it is returned but also @error is set to
 147  * %EV_DOCUMENT_ERROR_ENCRYPTED.
 148  *
 149  * Returns: a new #EvDocument, or %NULL.
 150  */
 151 EvDocument *
 152 ev_document_factory_get_document (const char *uri, GError **error)
 153 {
 154         EvDocument *document;
 155         int result;
 156         EvCompressionType compression;
 157         gchar *uri_unc = NULL;
 158         GError *err = NULL;
 159
 160         g_return_val_if_fail (uri != NULL, NULL);
 161
 162         document = get_document_from_uri (uri, TRUE, &compression, &err);
 163         g_assert (document != NULL || err != NULL);
 164
 165         if (document != NULL) {
 166                 uri_unc = ev_file_uncompress (uri, compression, &err);
 167                 if (uri_unc) {
 168                         g_object_set_data_full (G_OBJECT (document),
 169                                                 "uri-uncompressed",
 170                                                 uri_unc,
 171                                                 (GDestroyNotify) free_uncompressed_uri);
 172                 } else if (err != NULL) {
 173                         /* Error uncompressing file */
 174                         g_object_unref (document);
 175                         g_propagate_error (error, err);
 176                         return NULL;
 177                 }
 178
 179                 result = ev_document_load (document, uri_unc ? uri_unc : uri, &err);
 180
 181                 if (result == FALSE || err) {
 182                         if (err &&
 183                             g_error_matches (err, EV_DOCUMENT_ERROR, EV_DOCUMENT_ERROR_ENCRYPTED)) {
 184                                 g_propagate_error (error, err);
 185                                 return document;
 186                             }
 187                         /* else fall through to slow mime code section below */
 188                 } else {
 189                         return document;
 190                 }
 191
 192                 g_object_unref (document);
 193                 document = NULL;
 194         }
 195
 196         /* Try again with slow mime detection */
 197         g_clear_error (&err);
 198         uri_unc = NULL;
 199
 200         document = get_document_from_uri (uri, FALSE, &compression, &err);
 201         if (document == NULL) {
 202                 g_assert (err != NULL);
 203                 g_propagate_error (error, err);
 204                 return NULL;
 205         }
 206
 207         uri_unc = ev_file_uncompress (uri, compression, &err);
 208         if (uri_unc) {
 209                 g_object_set_data_full (G_OBJECT (document),
 210                                         "uri-uncompressed",
 211                                         uri_unc,
 212                                         (GDestroyNotify) free_uncompressed_uri);
 213         } else if (err != NULL) {
 214                 /* Error uncompressing file */
 215                 g_propagate_error (error, err);
 216
 217                 g_object_unref (document);
 218                 return NULL;
 219         }
 220
 221         result = ev_document_load (document, uri_unc ? uri_unc : uri, &err);
 222         if (result == FALSE) {
 223                 if (err == NULL) {
 224                         /* FIXME: this really should not happen; the backend should
 225                          * always return a meaningful error.
 226                          */
 227                         g_set_error_literal (&err,
 228                                              EV_DOCUMENT_ERROR,
 229                                              EV_DOCUMENT_ERROR_INVALID,
 230                                              _("Unknown MIME Type"));
 231                 } else if (g_error_matches (err, EV_DOCUMENT_ERROR, EV_DOCUMENT_ERROR_ENCRYPTED)) {
 232                         g_propagate_error (error, err);
 233                         return document;
 234                 }
 235
 236                 g_object_unref (document);
 237                 document = NULL;
 238
 239                 g_propagate_error (error, err);
 240         }
 241
 242         return document;
 243 }
 244
 245 static void
 246 file_filter_add_mime_types (EvTypeInfo *info, GtkFileFilter *filter)
 247 {
 248         const gchar *mime_type;
 249         gint         i = 0;
 250
 251         while ((mime_type = info->mime_types[i++]))
 252                 gtk_file_filter_add_mime_type (filter, mime_type);
 253 }
 254
 255 /**
 256  * ev_document_factory_add_filters:
 257  * @chooser: a #GtkFileChooser
 258  * @document: a #EvDocument, or %NULL
 259  *
 260  * Adds some file filters to @chooser.
 261
 262  * Always add a "All documents" format.
 263  *
 264  * If @document is not %NULL, adds a #GtkFileFilter for @document's MIME type.
 265  *
 266  * If @document is %NULL, adds a #GtkFileFilter for each document type that evince
 267  * can handle.
 268  */
 269 void
 270 ev_document_factory_add_filters (GtkWidget *chooser, EvDocument *document)
 271 {
 272         GList         *all_types;
 273         GtkFileFilter *filter;
 274         GtkFileFilter *default_filter;
 275         GtkFileFilter *document_filter;
 276
 277         g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
 278         g_return_if_fail (document == NULL || EV_IS_DOCUMENT (document));
 279
 280         all_types = ev_backends_manager_get_all_types_info ();
 281
 282         default_filter = document_filter = filter = gtk_file_filter_new ();
 283         gtk_file_filter_set_name (filter, _("All Documents"));
 284         g_list_foreach (all_types, (GFunc)file_filter_add_mime_types, filter);
 285         gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), filter);
 286
 287         if (document) {
 288                 EvTypeInfo *info;
 289
 290                 info = ev_backends_manager_get_document_type_info (document);
 291                 default_filter = filter = gtk_file_filter_new ();
 292                 gtk_file_filter_set_name (filter, info->desc);
 293                 file_filter_add_mime_types (info, filter);
 294                 g_free (info);
 295                 gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), filter);
 296         } else {
 297                 GList *l;
 298
 299                 for (l = all_types; l; l = g_list_next (l)){
 300                         EvTypeInfo *info;
 301
 302                         info = (EvTypeInfo *)l->data;
 303
 304                         default_filter = filter = gtk_file_filter_new ();
 305                         gtk_file_filter_set_name (filter, info->desc);
 306                         file_filter_add_mime_types (info, filter);
 307                         gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), filter);
 308                 }
 309         }
 310
 311         g_list_foreach (all_types, (GFunc)g_free, NULL);
 312         g_list_free (all_types);
 313
 314         filter = gtk_file_filter_new ();
 315         gtk_file_filter_set_name (filter, _("All Files"));
 316         gtk_file_filter_add_pattern (filter, "*");
 317         gtk_file_chooser_add_filter (GTK_FILE_CHOOSER (chooser), filter);
 318
 319         gtk_file_chooser_set_filter (GTK_FILE_CHOOSER (chooser),
 320                                      document == NULL ? document_filter : default_filter);
 321 }