]> www.fi.muni.cz Git - evince.git/blobdiff - backend/comics/comics-document.c
[comics] Fixes handling of the tmp folder
[evince.git] / backend / comics / comics-document.c
index c55f58bb9fe3e6ae0e75dc0f4d7b297bf4b5d7be..ca154710f41729653b6d69964fa5f4f219c7d92e 100644 (file)
 #include <config.h>
 #include <unistd.h>
 #include <string.h>
-#include <glib/gi18n.h>
+#include <glib/gi18n-lib.h>
+#include <glib/gstdio.h>
 #include <gio/gio.h>
+#include <sys/wait.h>
+#include <stdlib.h>
+#include <errno.h>
 
 #include "comics-document.h"
 #include "ev-document-misc.h"
@@ -34,18 +38,39 @@ struct _ComicsDocumentClass
 {
        GObjectClass parent_class;
 };
+typedef enum 
+{
+       RARLABS,
+       GNAUNRAR,
+       UNZIP,
+       P7ZIP
+} ComicBookDecompressType;
 
 struct _ComicsDocument
 {
        GObject parent_instance;
+       gchar    *archive, *dir;
+       GSList   *page_names;
+       gint     n_pages;
+       gchar    *selected_command;
+       gchar    *extract_command, *list_command, *decompress_tmp;
+       gboolean regex_arg;
+       ComicBookDecompressType command_usage;
+};
 
-       gchar  *archive;
-       GSList *page_names;
-       int     n_pages;
-       char   *extract_command;
+struct 
+{
+       char *extract, *list, *decompress_tmp; 
        gboolean regex_arg;
+} command_usage_def[] = {
+       {"%s p -c- -ierr", "%s vb -c- -- %s", NULL          , FALSE},
+       {NULL            , "%s t %s"        , "%s -xf %s %s", TRUE },
+       {"%s -p -C"      , "%s -Z -1 -- %s" , NULL          , TRUE },
+       {"%s x -so"      , "%s l -- %s"     , NULL          , TRUE }
 };
 
+
 typedef struct _ComicsDocumentClass ComicsDocumentClass;
 
 static void       comics_document_document_iface_init (EvDocumentIface *iface);
@@ -102,6 +127,215 @@ comics_regex_quote (const char *s)
     return ret;
 }
 
+/* This function manages the command for decompressing a comic book */
+static gboolean 
+comics_decompress_temp_dir (const gchar *command_decompress_tmp,
+                           const gchar *command, 
+                           GError      **error)
+{
+       gboolean success;
+       gchar *std_out, *basename;
+       GError *err = NULL;
+       gint retval;
+       
+       success = g_spawn_command_line_sync (command_decompress_tmp, &std_out, 
+                                            NULL, &retval, &err);
+       basename = g_path_get_basename (command);
+       if (!success) {
+               g_set_error (error,
+                            EV_DOCUMENT_ERROR, 
+                            EV_DOCUMENT_ERROR_INVALID,
+                            _("Error launching the command “%s” in order to "
+                            "decompress the comic book: %s"),
+                            basename,
+                            err->message);
+               g_error_free (err);
+       } else if (WIFEXITED (retval)) {
+               if (WEXITSTATUS (retval) == EXIT_SUCCESS) {
+                       g_free (std_out);
+                       g_free (basename);
+                       return TRUE;
+               } else {
+                       g_set_error (error,
+                                    EV_DOCUMENT_ERROR,
+                                    EV_DOCUMENT_ERROR_INVALID,
+                                    _("The command “%s” failed at "
+                                    "decompressing the comic book."),
+                                    basename);
+                       g_free (std_out);
+               }
+       } else {
+               g_set_error (error,
+                            EV_DOCUMENT_ERROR,
+                            EV_DOCUMENT_ERROR_INVALID,
+                            _("The command “%s” did not end normally."),
+                            basename);
+               g_free (std_out);
+       }
+       g_free (basename);
+       return FALSE;
+}
+
+/* This function shows how to use the choosen command for decompressing a
+ * comic book file. It modifies fields of the ComicsDocument struct with 
+ * this information */
+static gboolean 
+comics_generate_command_lines (ComicsDocument *comics_document, 
+                              GError         **error)
+{
+       gchar *quoted_file;
+       ComicBookDecompressType type;
+       
+       type = comics_document->command_usage;
+       quoted_file = g_shell_quote (comics_document->archive);
+       
+       comics_document->extract_command = 
+                           g_strdup_printf (command_usage_def[type].extract, 
+                                            comics_document->selected_command);
+       comics_document->list_command =
+                           g_strdup_printf (command_usage_def[type].list, 
+                                            comics_document->selected_command, 
+                                            quoted_file);
+       comics_document->regex_arg = command_usage_def[type].regex_arg;
+       if (command_usage_def[type].decompress_tmp) {
+               comics_document->dir = ev_tmp_directory (NULL); 
+               comics_document->decompress_tmp = 
+                       g_strdup_printf (command_usage_def[type].decompress_tmp, 
+                                        comics_document->selected_command, 
+                                        quoted_file, 
+                                        comics_document->dir);
+               g_free (quoted_file);
+               /* unrar-free can't create directories so we do it on its 
+                * behalf */
+               if (type == GNAUNRAR) {
+                       if (g_mkdir_with_parents (comics_document->dir, 0700) != 
+                           0) {
+                               int errsv = errno;
+                               g_set_error (error,
+                                            EV_DOCUMENT_ERROR,
+                                            EV_DOCUMENT_ERROR_INVALID,
+                                            _("Failed to create a temporary "
+                                            "directory."));
+                               g_warning ("Failed to create directory %s: %s", 
+                                          comics_document->dir, 
+                                          g_strerror (errsv));
+                               
+                               return FALSE;
+                       }
+               }
+               if (!comics_decompress_temp_dir (comics_document->decompress_tmp, 
+                   comics_document->selected_command, error))
+                       return FALSE;
+               else
+                       return TRUE;
+       } else {
+               g_free (quoted_file);
+               return TRUE;
+       }
+
+}
+
+/* This function chooses an external command for decompressing a comic 
+ * book based on its mime tipe. */
+static gboolean 
+comics_check_decompress_command        (gchar          *mime_type, 
+                                ComicsDocument *comics_document,
+                                GError         **error)
+{
+       gboolean success;
+       gchar *std_out, *std_err;
+       gint retval;
+       GError *err = NULL;
+       
+       /* FIXME, use proper cbr/cbz mime types once they're
+        * included in shared-mime-info */
+       
+       if (!strcmp (mime_type, "application/x-cbr") ||
+           !strcmp (mime_type, "application/x-rar")) {
+               /* The RARLAB provides a no-charge proprietary (freeware) 
+               * decompress-only client for Linux called unrar. Another 
+               * option is a GPLv2-licensed command-line tool developed by 
+               * the Gna! project. Confusingly enough, the free software RAR 
+               * decoder is also named unrar. For this reason we need to add 
+               * some lines for disambiguation. Sorry for the added the 
+               * complexity but it's life :)
+               * Finally, some distributions, like Debian, rename this free 
+               * option as unrar-free. 
+               * */
+               comics_document->selected_command = 
+                                       g_find_program_in_path ("unrar");
+               if (comics_document->selected_command) {
+                       /* We only use std_err to avoid printing useless error 
+                        * messages on the terminal */
+                       success = 
+                               g_spawn_command_line_sync (
+                                             comics_document->selected_command, 
+                                                          &std_out, &std_err,
+                                                          &retval, &err);
+                       if (!success) {
+                               g_propagate_error (error, err);
+                               g_error_free (err);
+                               return FALSE;
+                       /* I don't check retval status because RARLAB unrar 
+                        * doesn't have a way to return 0 without involving an 
+                        * operation with a file*/
+                       } else if (WIFEXITED (retval)) {
+                               if (g_strrstr (std_out,"freeware") != NULL)
+                                       /* The RARLAB freeware client */
+                                       comics_document->command_usage = RARLABS;
+                               else
+                                       /* The Gna! free software client */
+                                       comics_document->command_usage = GNAUNRAR;
+
+                               g_free (std_out);
+                               g_free (std_err);
+                               return TRUE;
+                       }
+               }
+               /* The Gna! free software client with Debian naming convention */
+               comics_document->selected_command = 
+                               g_find_program_in_path ("unrar-free");
+               if (comics_document->selected_command) {
+                       comics_document->command_usage = GNAUNRAR;
+                       return TRUE;
+               }
+
+       } else if (!strcmp (mime_type, "application/x-cbz") ||
+                  !strcmp (mime_type, "application/zip")) {
+               /* InfoZIP's unzip program */
+               comics_document->selected_command = 
+                               g_find_program_in_path ("unzip");
+               if (comics_document->selected_command) {
+                       comics_document->command_usage = UNZIP;
+                       return TRUE;
+               }
+
+       } else if (!strcmp (mime_type, "application/x-cb7") ||
+                  !strcmp (mime_type, "application/x-7z-compressed")) {
+               /* 7zr is a light stand-alone executable that supports only 
+                * 7z/LZMA/BCJ */
+                       comics_document->selected_command = 
+                               g_find_program_in_path ("7zr");
+                       if (comics_document->selected_command) {
+                               comics_document->command_usage = P7ZIP;
+                               return TRUE;
+                       }
+       } else {
+               g_set_error (error,
+                            EV_DOCUMENT_ERROR,
+                            EV_DOCUMENT_ERROR_INVALID,
+                            _("Not a comic book MIME type: %s"),
+                            mime_type);
+                            return FALSE;
+       }
+       g_set_error_literal (error,
+                            EV_DOCUMENT_ERROR,
+                            EV_DOCUMENT_ERROR_INVALID,
+                            _("Can't find an appropiate command to "
+                            "decompress this type of comic book"));
+       return FALSE;
+}
+
 static gboolean
 comics_document_load (EvDocument *document,
                      const char *uri,
@@ -109,61 +343,68 @@ comics_document_load (EvDocument *document,
 {
        ComicsDocument *comics_document = COMICS_DOCUMENT (document);
        GSList *supported_extensions;
-       gchar *list_files_command = NULL, *std_out, *quoted_file;
+       gchar *std_out;
        gchar *mime_type;
        gchar **cbr_files;
        gboolean success;
        int i, retval;
+       GError *err = NULL;
 
        comics_document->archive = g_filename_from_uri (uri, NULL, error);
-       g_return_val_if_fail (comics_document->archive != NULL, FALSE);
+       if (!comics_document->archive)
+               return FALSE;
 
-       quoted_file = g_shell_quote (comics_document->archive);
-       mime_type = ev_file_get_mime_type (uri, FALSE, NULL);
+       mime_type = ev_file_get_mime_type (uri, FALSE, &err);
+       if (!mime_type) {
+               if (err) {
+                       g_propagate_error (error, err);
+               } else {
+                       g_set_error_literal (error,
+                                            EV_DOCUMENT_ERROR,
+                                            EV_DOCUMENT_ERROR_INVALID,
+                                            _("Unknown MIME Type"));
+               }
 
-       /* FIXME, use proper cbr/cbz mime types once they're
-        * included in shared-mime-info */
-       if (!strcmp (mime_type, "application/x-cbr") ||
-           !strcmp (mime_type, "application/x-rar")) {
-               comics_document->extract_command =
-                       g_strdup ("unrar p -c- -ierr");
-               list_files_command =
-                       g_strdup_printf ("unrar vb -c- -- %s", quoted_file);
-               comics_document->regex_arg = FALSE;
-       } else if (!strcmp (mime_type, "application/x-cbz") ||
-                  !strcmp (mime_type, "application/zip")) {
-               comics_document->extract_command =
-                       g_strdup ("unzip -p -C");
-               list_files_command = 
-                       g_strdup_printf ("zipinfo -1 -- %s", quoted_file);
-               comics_document->regex_arg = TRUE;
-       } else if (!strcmp (mime_type, "application/x-cb7")) {
-               comics_document->extract_command =
-                       g_strdup ("7zr x -so");
-               list_files_command = 
-                       g_strdup_printf ("7zr l -- %s", quoted_file);
-               comics_document->regex_arg = TRUE;
+               return FALSE;
+       }
+       
+       if (!comics_check_decompress_command (mime_type, comics_document, 
+       error)) {       
+               g_free (mime_type);
+               return FALSE;
+       } else if (!comics_generate_command_lines (comics_document, error)) {
+                  g_free (mime_type);
+               return FALSE;
        }
 
        g_free (mime_type);
-       g_free (quoted_file);
 
        /* Get list of files in archive */
-       success = g_spawn_command_line_sync (list_files_command,
+       success = g_spawn_command_line_sync (comics_document->list_command,
                                             &std_out, NULL, &retval, error);
-       g_free (list_files_command);
 
        if (!success) {
                return FALSE;
-       } else if (retval != 0) {
-               g_set_error (error,
-                            EV_DOCUMENT_ERROR,
-                            EV_DOCUMENT_ERROR_INVALID,
-                            _("File corrupted."));
+       } else if (!WIFEXITED(retval) || WEXITSTATUS(retval) != EXIT_SUCCESS) {
+               g_set_error_literal (error,
+                                     EV_DOCUMENT_ERROR,
+                                     EV_DOCUMENT_ERROR_INVALID,
+                                     _("File corrupted"));
                return FALSE;
        }
 
+       /* FIXME: is this safe against filenames containing \n in the archive ? */
        cbr_files = g_strsplit (std_out, "\n", 0);
+       g_free (std_out);
+
+       if (!cbr_files) {
+               g_set_error_literal (error,
+                                    EV_DOCUMENT_ERROR,
+                                    EV_DOCUMENT_ERROR_INVALID,
+                                    _("No files in archive"));
+               return FALSE;
+       }
+
        supported_extensions = get_supported_image_extensions ();
        for (i = 0; cbr_files[i] != NULL; i++) {
                gchar *suffix = g_strrstr (cbr_files[i], ".");
@@ -184,7 +425,6 @@ comics_document_load (EvDocument *document,
                g_free (suffix);
        }
 
-       g_free (std_out);
        g_strfreev (cbr_files);
        g_slist_foreach (supported_extensions, (GFunc) g_free, NULL);
        g_slist_free (supported_extensions);
@@ -230,43 +470,62 @@ comics_document_get_page_size (EvDocument *document,
        gboolean success, got_size = FALSE;
        gint outpipe = -1;
        GPid child_pid = -1;
-
-       argv = extract_argv (document, page->index);
-       success = g_spawn_async_with_pipes (NULL, argv, NULL,
-                                           G_SPAWN_SEARCH_PATH | G_SPAWN_STDERR_TO_DEV_NULL,
-                                           NULL, NULL,
-                                           &child_pid,
-                                           NULL, &outpipe, NULL, NULL);
-       g_strfreev (argv);
-       g_return_if_fail (success == TRUE);
-
-       loader = gdk_pixbuf_loader_new ();
-       g_signal_connect (loader, "area-prepared",
-                         G_CALLBACK (get_page_size_area_prepared_cb),
-                         &got_size);
-
-       while (outpipe >= 0) {
-               gssize bytes = read (outpipe, buf, 1024);
+       gssize bytes;
+       GdkPixbuf *pixbuf;
+       gchar *filename;
+       ComicsDocument *comics_document = COMICS_DOCUMENT (document);
+       
+       if (!comics_document->decompress_tmp) {
+               argv = extract_argv (document, page->index);
+               success = g_spawn_async_with_pipes (NULL, argv, NULL,
+                                                   G_SPAWN_SEARCH_PATH | 
+                                                   G_SPAWN_STDERR_TO_DEV_NULL,
+                                                   NULL, NULL,
+                                                   &child_pid,
+                                                   NULL, &outpipe, NULL, NULL);
+               g_strfreev (argv);
+               g_return_if_fail (success == TRUE);
+
+               loader = gdk_pixbuf_loader_new ();
+               g_signal_connect (loader, "area-prepared",
+                                 G_CALLBACK (get_page_size_area_prepared_cb),
+                                 &got_size);
+
+               while (outpipe >= 0) {
+                       bytes = read (outpipe, buf, 1024);
                
-               if (bytes > 0)
+                       if (bytes > 0)
                        gdk_pixbuf_loader_write (loader, buf, bytes, NULL);
-               if (bytes <= 0 || got_size) {
-                       close (outpipe);
-                       outpipe = -1;
-                       gdk_pixbuf_loader_close (loader, NULL);
+                       if (bytes <= 0 || got_size) {
+                               close (outpipe);
+                               outpipe = -1;
+                               gdk_pixbuf_loader_close (loader, NULL);
+                       }
+               }
+
+               if (gdk_pixbuf_loader_get_pixbuf (loader)) {
+                       pixbuf = gdk_pixbuf_loader_get_pixbuf (loader);
+                       if (width)
+                               *width = gdk_pixbuf_get_width (pixbuf);
+                       if (height)
+                               *height = gdk_pixbuf_get_height (pixbuf);
                }
-       }
 
-       if (gdk_pixbuf_loader_get_pixbuf (loader)) {
-               GdkPixbuf *pixbuf = gdk_pixbuf_loader_get_pixbuf (loader);
+               g_spawn_close_pid (child_pid);
+               g_object_unref (loader);
+       } else {
+               filename = g_build_filename (comics_document->dir,      
+                                            (char*) g_slist_nth_data (
+                                            comics_document->page_names, 
+                                            page->index),
+                                            NULL);
+               pixbuf = gdk_pixbuf_new_from_file (filename, NULL);
+               g_free (filename);
                if (width)
                        *width = gdk_pixbuf_get_width (pixbuf);
                if (height)
                        *height = gdk_pixbuf_get_height (pixbuf);
        }
-
-       g_spawn_close_pid (child_pid);
-       g_object_unref (loader);
 }
 
 static void
@@ -288,38 +547,63 @@ comics_document_render_pixbuf (EvDocument      *document,
        gboolean success;
        gint outpipe = -1;
        GPid child_pid = -1;
-
-       argv = extract_argv (document, rc->page->index);
-       success = g_spawn_async_with_pipes (NULL, argv, NULL,
-                                           G_SPAWN_SEARCH_PATH
-                                           | G_SPAWN_STDERR_TO_DEV_NULL,
-                                           NULL, NULL,
-                                           &child_pid,
-                                           NULL, &outpipe, NULL, NULL);
-       g_strfreev (argv);
-       g_return_val_if_fail (success == TRUE, NULL);
-
-       loader = gdk_pixbuf_loader_new ();
-       g_signal_connect (loader, "size-prepared",
-                         G_CALLBACK (render_pixbuf_size_prepared_cb), &rc->scale);
-
-       while (outpipe >= 0) {
-               gssize bytes = read (outpipe, buf, 4096);
-
-               if (bytes > 0) {
-                       gdk_pixbuf_loader_write (loader, buf, bytes, NULL);
-               } else if (bytes <= 0) {
-                       close (outpipe);
-                       gdk_pixbuf_loader_close (loader, NULL);
-                       outpipe = -1;
+       gssize bytes;
+       gint width, height;
+       gchar *filename;
+       ComicsDocument *comics_document = COMICS_DOCUMENT (document);
+       
+       if (!comics_document->decompress_tmp) {
+               argv = extract_argv (document, rc->page->index);
+               success = g_spawn_async_with_pipes (NULL, argv, NULL,
+                                                   G_SPAWN_SEARCH_PATH | 
+                                                   G_SPAWN_STDERR_TO_DEV_NULL,
+                                                   NULL, NULL,
+                                                   &child_pid,
+                                                   NULL, &outpipe, NULL, NULL);
+               g_strfreev (argv);
+               g_return_val_if_fail (success == TRUE, NULL);
+
+               loader = gdk_pixbuf_loader_new ();
+               g_signal_connect (loader, "size-prepared",
+                                 G_CALLBACK (render_pixbuf_size_prepared_cb), 
+                                 &rc->scale);
+
+               while (outpipe >= 0) {
+                       bytes = read (outpipe, buf, 4096);
+
+                       if (bytes > 0) {
+                               gdk_pixbuf_loader_write (loader, buf, bytes, 
+                               NULL);
+                       } else if (bytes <= 0) {
+                               close (outpipe);
+                               gdk_pixbuf_loader_close (loader, NULL);
+                               outpipe = -1;
+                       }
                }
-       }
-
-       rotated_pixbuf = gdk_pixbuf_rotate_simple (gdk_pixbuf_loader_get_pixbuf (loader),
-                                                  360 - rc->rotation);
-       g_spawn_close_pid (child_pid);
-       g_object_unref (loader);
 
+               rotated_pixbuf = gdk_pixbuf_rotate_simple (
+                                       gdk_pixbuf_loader_get_pixbuf (loader),
+                                       360 - rc->rotation);
+               g_spawn_close_pid (child_pid);
+               g_object_unref (loader);
+       } else {
+               filename = 
+                       g_build_filename (comics_document->dir,
+                                         (char*) g_slist_nth_data (
+                                               comics_document->page_names, 
+                                               rc->page->index),
+                                         NULL);
+          
+               gdk_pixbuf_get_file_info (filename, &width, &height);
+               
+               rotated_pixbuf = 
+                 gdk_pixbuf_rotate_simple (gdk_pixbuf_new_from_file_at_size (
+                                           filename, width * (rc->scale) + 0.5,
+                                           height * (rc->scale) + 0.5, NULL),
+                                           360 - rc->rotation);
+               g_free (filename);
+       
+       }
        return rotated_pixbuf;
 }
 
@@ -350,22 +634,61 @@ render_pixbuf_size_prepared_cb (GdkPixbufLoader *loader,
        gdk_pixbuf_loader_set_size (loader, w, h);
 }
 
+/**
+ * comics_remove_dir: Removes a directory recursively. 
+ * Returns:
+ *     0 if it was successfully deleted,
+ *     -1 if an error occurred                 
+ */
+static int 
+comics_remove_dir (gchar *path_name) 
+{
+       GDir  *content_dir;
+       const gchar *filename;
+       gchar *filename_with_path;
+       
+       if (g_file_test (path_name, G_FILE_TEST_IS_DIR)) {
+               content_dir = g_dir_open  (path_name, 0, NULL);
+               filename  = g_dir_read_name (content_dir);
+               while (filename) {
+                       filename_with_path = 
+                               g_build_filename (path_name, 
+                                                 filename, NULL);
+                       comics_remove_dir (filename_with_path);
+                       g_free (filename_with_path);
+                       filename = g_dir_read_name (content_dir);
+               }
+               g_dir_close (content_dir);
+       }
+       /* Note from g_remove() documentation: on Windows, it is in general not 
+        * possible to remove a file that is open to some process, or mapped 
+        * into memory.*/
+       return (g_remove (path_name));
+}
+
 static void
 comics_document_finalize (GObject *object)
 {
        ComicsDocument *comics_document = COMICS_DOCUMENT (object);
-
-       if (comics_document->archive)
-               g_free (comics_document->archive);
-
+       
+       if (comics_document->decompress_tmp) {
+               if (comics_remove_dir (comics_document->dir) == -1)
+                       g_warning (_("There was an error deleting “%s”."),
+                                  comics_document->dir);
+               g_free (comics_document->dir);
+               g_remove (ev_tmp_dir ());
+       }
+       
        if (comics_document->page_names) {
                g_slist_foreach (comics_document->page_names,
                                 (GFunc) g_free, NULL);
                g_slist_free (comics_document->page_names);
        }
 
-       if (comics_document->extract_command)
-               g_free (comics_document->extract_command);
+       g_free (comics_document->archive);
+       g_free (comics_document->selected_command);
+       g_free (comics_document->extract_command);
+       g_free (comics_document->list_command);
 
        G_OBJECT_CLASS (comics_document_parent_class)->finalize (object);
 }
@@ -500,7 +823,8 @@ extract_argv (EvDocument *document, gint page)
        g_shell_parse_argv (command_line, NULL, &argv, &err);
        
        if (err) {
-               g_warning ("Error %s", err->message);
+               g_warning (_("Error %s"), err->message);
+               g_error_free (err);
                return NULL;
        }