]> www.fi.muni.cz Git - evince.git/blobdiff - backend/comics/comics-document.c
[comics] Do not initalize GPid's with -1
[evince.git] / backend / comics / comics-document.c
index 44b97518742a9bd8db93155b9e9cf941b86c6737..9f657c24e1be667943bef0ce3e49532722267ef1 100644 (file)
@@ -1,5 +1,6 @@
 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; c-indent-level: 8 -*- */
 /*
+ * Copyright (C) 2009, Juanjo Marín <juanj.marin@juntadeandalucia.es>
  * Copyright (C) 2005, Teemu Tervo <teemu.tervo@gmx.net>
  *
  * This program is free software; you can redistribute it and/or modify
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  */
 
-#include "config.h"
-
 #include <config.h>
+
 #include <unistd.h>
 #include <string.h>
+#include <stdlib.h>
+#include <errno.h>
+
+#include <glib.h>
 #include <glib/gi18n-lib.h>
 #include <glib/gstdio.h>
 #include <gio/gio.h>
-#include <sys/wait.h>
-#include <stdlib.h>
-#include <errno.h>
+
+#ifdef G_OS_WIN32
+# define WIFEXITED(x) ((x) != 3)
+# define WEXITSTATUS(x) (x)
+#else
+# include <sys/wait.h>
+#endif
 
 #include "comics-document.h"
 #include "ev-document-misc.h"
 #include "ev-document-thumbnails.h"
 #include "ev-file-helpers.h"
 
+typedef enum
+{
+       RARLABS,
+       GNAUNRAR,
+       UNZIP,
+       P7ZIP,
+       TAR
+} ComicBookDecompressType;
+
+typedef struct _ComicsDocumentClass ComicsDocumentClass;
+
 struct _ComicsDocumentClass
 {
-       GObjectClass parent_class;
+       EvDocumentClass parent_class;
 };
 
 struct _ComicsDocument
 {
-       GObject parent_instance;
+       EvDocument parent_instance;
 
        gchar    *archive, *dir;
-       GSList   *page_names;
-       gint     n_pages;
+       GPtrArray *page_names;
        gchar    *selected_command;
-       gchar    *extract_command, *list_command;
-       gboolean regex_arg, flag_temp, flag_FLOSS;
+       gchar    *extract_command, *list_command, *decompress_tmp;
+       gint     offset;
+       ComicBookDecompressType command_usage;
 };
 
-typedef struct _ComicsDocumentClass ComicsDocumentClass;
+#define OFFSET_7Z 53
+#define NO_OFFSET 0
+
+/* For perfomance reasons of 7z* we've choosen to decompress on the temporary 
+ * directory instead of decompressing on the stdout */
+
+/**
+ * @extract: command line arguments to pass to extract a file from the archive
+ *   to stdout.
+ * @list: command line arguments to list the archive contents
+ * @decompress_tmp: command line arguments to pass to extract the archive
+ *   into a directory.
+ * @offset: the position offset of the filename on each line in the output of
+ *   running the @list command
+ */
+typedef struct {
+        char *extract;
+        char *list;
+        char *decompress_tmp;
+        gint offset;
+} ComicBookDecompressCommand;
+
+static const ComicBookDecompressCommand command_usage_def[] = {
+        /* RARLABS unrar */
+       {"%s p -c- -ierr --", "%s vb -c- -- %s", NULL             , NO_OFFSET},
+
+        /* GNA! unrar */
+       {NULL               , "%s t %s"        , "%s -xf %s %s"   , NO_OFFSET},
+
+        /* unzip */
+       {"%s -p -C --"      , "%s -Z -1 -- %s" , NULL             , NO_OFFSET},
+
+        /* 7zip */
+       {NULL               , "%s l -- %s"     , "%s x -y %s -o%s", OFFSET_7Z},
+
+        /* tar */
+       {"%s -xOf"          , "%s -tf %s"      , NULL             , NO_OFFSET}
+};
 
-static void       comics_document_document_iface_init (EvDocumentIface *iface);
 static void       comics_document_document_thumbnails_iface_init (EvDocumentThumbnailsIface *iface);
 
 static GSList*    get_supported_image_extensions (void);
@@ -73,39 +128,6 @@ EV_BACKEND_REGISTER_WITH_CODE (ComicsDocument, comics_document,
                                                comics_document_document_thumbnails_iface_init);
        } );
 
-static char *
-comics_regex_quote (const char *s)
-{
-    char *ret, *d;
-
-    d = ret = g_malloc (strlen (s) * 4 + 3);
-    
-    *d++ = '\'';
-
-    for (; *s; s++, d++) {
-       switch (*s) {
-       case '?':
-       case '|':
-       case '[':
-       case ']':
-       case '*':
-       case '\\':
-           *d++ = '\\';
-           break;
-       case '\'':
-           *d++ = '\'';
-           *d++ = '\\';
-           *d++ = '\'';
-           break;
-       }
-       *d = *s;
-    }
-    
-    *d++ = '\'';
-    *d = '\0';
-
-    return ret;
-}
 
 /* This function manages the command for decompressing a comic book */
 static gboolean 
@@ -164,118 +186,45 @@ comics_generate_command_lines (ComicsDocument *comics_document,
                               GError         **error)
 {
        gchar *quoted_file;
-       gchar *command_decompress_tmp, *checksum;
+       gchar *quoted_command;
+       ComicBookDecompressType type;
        
+       type = comics_document->command_usage;
        quoted_file = g_shell_quote (comics_document->archive);
-       
-       /* RARLabs software     */
-       if (g_str_has_suffix (comics_document->selected_command, "unrar") &&
-               !comics_document->flag_FLOSS) {
-               comics_document->extract_command =
-                       g_strdup_printf ("%s p -c- -ierr", 
-                                        comics_document->selected_command);
-               comics_document->list_command =
-                       g_strdup_printf ("%s vb -c- -- %s", 
-                                        comics_document->selected_command,
-                                        quoted_file);
-               comics_document->flag_temp = FALSE;
-               comics_document->regex_arg = FALSE;
-               g_free (quoted_file);
-               return TRUE;
-       }
-       
-       /* Gna! unrar */
-       if (g_str_has_suffix (comics_document->selected_command, "unrar-free")||
-           (g_str_has_suffix (comics_document->selected_command, "unrar") && 
-           comics_document->flag_FLOSS)) {
-               
-               comics_document->flag_temp = TRUE;
-               
-               checksum = 
-                       g_compute_checksum_for_string (G_CHECKSUM_MD5, 
-                                                      comics_document->archive,
-                                                      -1);
-               comics_document->dir = g_build_filename (ev_tmp_dir (), 
-                                                        checksum, NULL);
-               g_free (checksum);
-               /* unrar-free can't create directories so we do it on its 
-                * behalf */
-               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 on “%s”: %s"),
-                                    ev_tmp_dir (),
-                                    g_strerror (errsv));   
-                       g_free (quoted_file);
-                       comics_document->flag_temp = FALSE;
-                       g_free (comics_document->dir);
-                       return FALSE;
-               }
-               
-               command_decompress_tmp = 
-                       g_strdup_printf ("%s -xf %s %s", 
-                                        comics_document->selected_command, 
-                                        quoted_file, 
+       quoted_command = g_shell_quote (comics_document->selected_command);
+
+       comics_document->extract_command =
+                           g_strdup_printf (command_usage_def[type].extract,
+                                            quoted_command);
+       comics_document->list_command =
+                           g_strdup_printf (command_usage_def[type].list,
+                                            quoted_command, quoted_file);
+       comics_document->offset = command_usage_def[type].offset;
+       if (command_usage_def[type].decompress_tmp) {
+               comics_document->dir = ev_mkdtemp ("evince-comics-XXXXXX", error);
+                if (comics_document->dir == NULL)
+                        return FALSE;
+
+               /* unrar-free can't create directories, but ev_mkdtemp already created the dir */
+
+               comics_document->decompress_tmp =
+                       g_strdup_printf (command_usage_def[type].decompress_tmp, 
+                                        quoted_command, quoted_file,
                                         comics_document->dir);
-               
-               if (!comics_decompress_temp_dir (command_decompress_tmp, 
-                   comics_document->selected_command, error)){
-                       g_free (command_decompress_tmp);
-                       g_free (quoted_file);
+               g_free (quoted_file);
+               g_free (quoted_command);
+
+               if (!comics_decompress_temp_dir (comics_document->decompress_tmp,
+                   comics_document->selected_command, error))
                        return FALSE;
-               } else {
-                       comics_document->list_command = 
-                            g_strdup_printf ("%s t %s", 
-                                             comics_document->selected_command, 
-                                             quoted_file);
-                       comics_document->regex_arg = TRUE;
-                       g_free (command_decompress_tmp);
-                       g_free (quoted_file);
+               else
                        return TRUE;
-               }
-       }
-
-       /* InfoZIP's unzip */
-       if (g_str_has_suffix (comics_document->selected_command,"unzip")) {
-               comics_document->extract_command =
-                       g_strdup_printf ("%s -p -C", 
-                                        comics_document->selected_command);
-               comics_document->list_command = 
-                       g_strdup_printf ("%s -Z -1 -- %s", 
-                                        comics_document->selected_command, 
-                                        quoted_file);
-               comics_document->flag_temp = FALSE;
-               comics_document->regex_arg = TRUE;
-               g_free (quoted_file);
-               return TRUE;
-       }
-       
-       /* p7zip */
-       if (g_str_has_suffix (comics_document->selected_command,"7zr")) {
-               comics_document->extract_command =
-                       g_strdup_printf ("%s x -so", 
-                                        comics_document->selected_command);
-               comics_document->list_command = 
-                       g_strdup_printf ("%s l -- %s", 
-                                        comics_document->selected_command, 
-                                        quoted_file);
-               comics_document->flag_temp = FALSE;
-               comics_document->regex_arg = TRUE;
+       } else {
                g_free (quoted_file);
+               g_free (quoted_command);
                return TRUE;
        }
-       
-       /* You are not supposed to get here ! */
-       g_set_error_literal (error,
-                            EV_DOCUMENT_ERROR,
-                            EV_DOCUMENT_ERROR_INVALID,
-                            _("Internal error configuring the command for "
-                            "decompressing the comic book file"));
-       g_free (quoted_file);
-       return FALSE;
+
 }
 
 /* This function chooses an external command for decompressing a comic 
@@ -318,17 +267,18 @@ comics_check_decompress_command   (gchar          *mime_type,
                        if (!success) {
                                g_propagate_error (error, err);
                                g_error_free (err);
-                               return FALSE;
+                               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->flag_FLOSS = FALSE;
+                                       comics_document->command_usage = RARLABS;
                                else
                                        /* The Gna! free software client */
-                                       comics_document->flag_FLOSS = TRUE;
+                                       comics_document->command_usage = GNAUNRAR;
+
                                g_free (std_out);
                                g_free (std_err);
                                return TRUE;
@@ -337,23 +287,52 @@ comics_check_decompress_command   (gchar          *mime_type,
                /* 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) 
+               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)
+               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 */
+               /* 7zr, 7za and 7z are the commands from the p7zip project able 
+                * to decompress .7z files */ 
                        comics_document->selected_command = 
                                g_find_program_in_path ("7zr");
-                       if (comics_document->selected_command)
+                       if (comics_document->selected_command) {
+                               comics_document->command_usage = P7ZIP;
+                               return TRUE;
+                       }
+                       comics_document->selected_command = 
+                               g_find_program_in_path ("7za");
+                       if (comics_document->selected_command) {
+                               comics_document->command_usage = P7ZIP;
+                               return TRUE;
+                       }
+                       comics_document->selected_command = 
+                               g_find_program_in_path ("7z");
+                       if (comics_document->selected_command) {
+                               comics_document->command_usage = P7ZIP;
                                return TRUE;
+                       }
+       } else if (!strcmp (mime_type, "application/x-cbt") ||
+                  !strcmp (mime_type, "application/x-tar")) {
+               /* tar utility (Tape ARchive) */
+               comics_document->selected_command =
+                               g_find_program_in_path ("tar");
+               if (comics_document->selected_command) {
+                       comics_document->command_usage = TAR;
+                       return TRUE;
+               }
        } else {
                g_set_error (error,
                             EV_DOCUMENT_ERROR,
@@ -365,11 +344,18 @@ comics_check_decompress_command   (gchar          *mime_type,
        g_set_error_literal (error,
                             EV_DOCUMENT_ERROR,
                             EV_DOCUMENT_ERROR_INVALID,
-                            _("Can't find an appropiate command to "
+                            _("Can't find an appropriate command to "
                             "decompress this type of comic book"));
        return FALSE;
 }
 
+static int
+sort_page_names (gconstpointer a,
+                 gconstpointer b)
+{
+  return strcmp (* (const char **) a, * (const char **) b);
+}
+
 static gboolean
 comics_document_load (EvDocument *document,
                      const char *uri,
@@ -379,7 +365,7 @@ comics_document_load (EvDocument *document,
        GSList *supported_extensions;
        gchar *std_out;
        gchar *mime_type;
-       gchar **cbr_files;
+       gchar **cb_files, *cb_file;
        gboolean success;
        int i, retval;
        GError *err = NULL;
@@ -428,10 +414,10 @@ comics_document_load (EvDocument *document,
        }
 
        /* FIXME: is this safe against filenames containing \n in the archive ? */
-       cbr_files = g_strsplit (std_out, "\n", 0);
+       cb_files = g_strsplit (std_out, "\n", 0);
        g_free (std_out);
 
-       if (!cbr_files) {
+       if (!cb_files) {
                g_set_error_literal (error,
                                     EV_DOCUMENT_ERROR,
                                     EV_DOCUMENT_ERROR_INVALID,
@@ -439,31 +425,38 @@ comics_document_load (EvDocument *document,
                return FALSE;
        }
 
+        comics_document->page_names = g_ptr_array_sized_new (64);
+
        supported_extensions = get_supported_image_extensions ();
-       for (i = 0; cbr_files[i] != NULL; i++) {
-               gchar *suffix = g_strrstr (cbr_files[i], ".");
+       for (i = 0; cb_files[i] != NULL; i++) {
+               if (comics_document->offset != NO_OFFSET) {
+                       if (g_utf8_strlen (cb_files[i],-1) > 
+                           comics_document->offset) {
+                               cb_file = 
+                                       g_utf8_offset_to_pointer (cb_files[i], 
+                                                      comics_document->offset);
+                       } else {
+                               continue;
+                       }
+               } else {
+                       cb_file = cb_files[i];
+               }
+               gchar *suffix = g_strrstr (cb_file, ".");
                if (!suffix)
                        continue;
                suffix = g_ascii_strdown (suffix + 1, -1);
-
                if (g_slist_find_custom (supported_extensions, suffix,
                                         (GCompareFunc) strcmp) != NULL) {
-                       comics_document->page_names =
-                               g_slist_insert_sorted (
-                                       comics_document->page_names,
-                                       g_strdup (g_strstrip (cbr_files[i])),
-                                       (GCompareFunc) strcmp);
-                       comics_document->n_pages++;
+                        g_ptr_array_add (comics_document->page_names,
+                                         g_strstrip (g_strdup (cb_file)));
                }
-
                g_free (suffix);
        }
-
-       g_strfreev (cbr_files);
+       g_strfreev (cb_files);
        g_slist_foreach (supported_extensions, (GFunc) g_free, NULL);
        g_slist_free (supported_extensions);
 
-       if (comics_document->n_pages == 0) {
+       if (comics_document->page_names->len == 0) {
                g_set_error (error,
                             EV_DOCUMENT_ERROR,
                             EV_DOCUMENT_ERROR_INVALID,
@@ -472,6 +465,9 @@ comics_document_load (EvDocument *document,
                return FALSE;
        }
 
+        /* Now sort the pages */
+        g_ptr_array_sort (comics_document->page_names, sort_page_names);
+
        return TRUE;
 }
 
@@ -489,7 +485,12 @@ comics_document_save (EvDocument *document,
 static int
 comics_document_get_n_pages (EvDocument *document)
 {
-       return COMICS_DOCUMENT (document)->n_pages;
+       ComicsDocument *comics_document = COMICS_DOCUMENT (document);
+
+        if (comics_document->page_names == NULL)
+                return 0;
+
+       return comics_document->page_names->len;
 }
 
 static void
@@ -503,14 +504,13 @@ comics_document_get_page_size (EvDocument *document,
        guchar buf[1024];
        gboolean success, got_size = FALSE;
        gint outpipe = -1;
-       GPid child_pid = -1;
+       GPid child_pid;
        gssize bytes;
        GdkPixbuf *pixbuf;
        gchar *filename;
        ComicsDocument *comics_document = COMICS_DOCUMENT (document);
        
-       if (!comics_document->flag_temp) {
-               
+       if (!comics_document->decompress_tmp) {
                argv = extract_argv (document, page->index);
                success = g_spawn_async_with_pipes (NULL, argv, NULL,
                                                    G_SPAWN_SEARCH_PATH | 
@@ -549,10 +549,8 @@ comics_document_get_page_size (EvDocument *document,
                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),
+               filename = g_build_filename (comics_document->dir,
+                                             (char *) comics_document->page_names->pdata[page->index],
                                             NULL);
                pixbuf = gdk_pixbuf_new_from_file (filename, NULL);
                g_free (filename);
@@ -581,13 +579,13 @@ comics_document_render_pixbuf (EvDocument      *document,
        guchar buf[4096];
        gboolean success;
        gint outpipe = -1;
-       GPid child_pid = -1;
+       GPid child_pid;
        gssize bytes;
        gint width, height;
        gchar *filename;
        ComicsDocument *comics_document = COMICS_DOCUMENT (document);
        
-       if (!comics_document->flag_temp) {
+       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 | 
@@ -624,9 +622,7 @@ comics_document_render_pixbuf (EvDocument      *document,
        } else {
                filename = 
                        g_build_filename (comics_document->dir,
-                                         (char*) g_slist_nth_data (
-                                               comics_document->page_names, 
-                                               rc->page->index),
+                                          (char *) comics_document->page_names->pdata[rc->page->index],
                                          NULL);
           
                gdk_pixbuf_get_file_info (filename, &width, &height);
@@ -705,31 +701,23 @@ static void
 comics_document_finalize (GObject *object)
 {
        ComicsDocument *comics_document = COMICS_DOCUMENT (object);
-
-       if (comics_document->flag_temp) {
+       
+       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);
        }
        
-       if (comics_document->archive)
-               g_free (comics_document->archive);
-
        if (comics_document->page_names) {
-               g_slist_foreach (comics_document->page_names,
-                                (GFunc) g_free, NULL);
-               g_slist_free (comics_document->page_names);
+                g_ptr_array_foreach (comics_document->page_names, (GFunc) g_free, NULL);
+                g_ptr_array_free (comics_document->page_names, TRUE);
        }
 
-       if (comics_document->selected_command)
-               g_free (comics_document->selected_command);
-               
-       if (comics_document->extract_command)
-               g_free (comics_document->extract_command);
-               
-       if (comics_document->list_command)
-               g_free (comics_document->list_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);
 }
@@ -737,27 +725,16 @@ comics_document_finalize (GObject *object)
 static void
 comics_document_class_init (ComicsDocumentClass *klass)
 {
-       GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
-       gobject_class->finalize = comics_document_finalize;
-}
+       GObjectClass    *gobject_class = G_OBJECT_CLASS (klass);
+       EvDocumentClass *ev_document_class = EV_DOCUMENT_CLASS (klass);
 
-static EvDocumentInfo *
-comics_document_get_info (EvDocument *document)
-{
-       EvDocumentInfo *info;
-       info = g_new0 (EvDocumentInfo, 1);
-       return info;
-}
+       gobject_class->finalize = comics_document_finalize;
 
-static void
-comics_document_document_iface_init (EvDocumentIface *iface)
-{
-       iface->load = comics_document_load;
-       iface->save = comics_document_save;
-       iface->get_n_pages = comics_document_get_n_pages;
-       iface->get_page_size = comics_document_get_page_size;
-       iface->render = comics_document_render;
-       iface->get_info = comics_document_get_info;
+       ev_document_class->load = comics_document_load;
+       ev_document_class->save = comics_document_save;
+       ev_document_class->get_n_pages = comics_document_get_n_pages;
+       ev_document_class->get_page_size = comics_document_get_page_size;
+       ev_document_class->render = comics_document_render;
 }
 
 static void
@@ -766,7 +743,6 @@ comics_document_init (ComicsDocument *comics_document)
        comics_document->archive = NULL;
        comics_document->page_names = NULL;
        comics_document->extract_command = NULL;
-       comics_document->n_pages = 0;
 }
 
 /* Returns a list of file extensions supported by gdk-pixbuf */
@@ -847,28 +823,24 @@ extract_argv (EvDocument *document, gint page)
        char *command_line, *quoted_archive, *quoted_filename;
        GError *err = NULL;
 
+        if (page >= comics_document->page_names->len)
+                return NULL;
+
        quoted_archive = g_shell_quote (comics_document->archive);
-       if (comics_document->regex_arg) {
-               quoted_filename = comics_regex_quote (
-                       g_slist_nth_data (comics_document->page_names, page));
-       } else {
-               quoted_filename = g_shell_quote (
-                       g_slist_nth_data (comics_document->page_names, page));
-       }
+       quoted_filename = g_shell_quote (comics_document->page_names->pdata[page]);
 
-       command_line = g_strdup_printf ("%s -- %s %s",
+       command_line = g_strdup_printf ("%s %s %s",
                                        comics_document->extract_command,
                                        quoted_archive,
                                        quoted_filename);
-
        g_shell_parse_argv (command_line, NULL, &argv, &err);
-       
+
        if (err) {
                g_warning (_("Error %s"), err->message);
                g_error_free (err);
                return NULL;
        }
-       
+
        g_free (command_line);
        g_free (quoted_archive);
        g_free (quoted_filename);