]> www.fi.muni.cz Git - evince.git/blobdiff - backend/comics/comics-document.c
[comics] Support for cb7 using the p7zip commands.
[evince.git] / backend / comics / comics-document.c
index 3825074aac7643be36717915a0928ec4b8c0a3c3..b6059b7e5e5d1994ddf782f9ea686831563d7a79 100644 (file)
@@ -38,20 +38,47 @@ 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;
-       gboolean regex_arg, flag_temp, flag_FLOSS;
+       gchar    *extract_command, *list_command, *decompress_tmp;
+       gboolean regex_arg;
+       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 */
+
+struct {
+       char *extract, *list, *decompress_tmp; 
+       gboolean regex_arg;
+       gint offset;
+} command_usage_def[] = {
+       {"%s p -c- -ierr", "%s vb -c- -- %s", NULL             , FALSE, NO_OFFSET},
+       {NULL            , "%s t %s"        , "%s -xf %s %s"   , TRUE , NO_OFFSET},
+       {"%s -p -C"      , "%s -Z -1 -- %s" , NULL             , TRUE , NO_OFFSET},
+       {NULL            , "%s l -- %s"     , "%s x -y %s -o%s", FALSE, OFFSET_7Z}
+};
+
+
+typedef struct    _ComicsDocumentClass ComicsDocumentClass;
 
 static void       comics_document_document_iface_init (EvDocumentIface *iface);
 static void       comics_document_document_thumbnails_iface_init (EvDocumentThumbnailsIface *iface);
@@ -109,9 +136,9 @@ comics_regex_quote (const char *s)
 
 /* 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)
+comics_decompress_temp_dir (const gchar *command_decompress_tmp,
+                           const gchar *command, 
+                           GError      **error)
 {
        gboolean success;
        gchar *std_out, *basename;
@@ -119,15 +146,17 @@ comics_decompress_temp_dir (const gchar       *command_decompress_tmp,
        gint retval;
        
        success = g_spawn_command_line_sync (command_decompress_tmp, &std_out, 
-                                               NULL, &retval, &err);
+                                            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 for decompressing "
-                         "the comic book to the temporary directory: %s"), basename, err->message);
-                       g_error_free (err);
+                            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);
@@ -135,17 +164,19 @@ comics_decompress_temp_dir (const gchar       *command_decompress_tmp,
                        return TRUE;
                } else {
                        g_set_error (error,
-                               EV_DOCUMENT_ERROR,
-                               EV_DOCUMENT_ERROR_INVALID,
-                               _("The command %s failed to decompress the "
-                                 "comic book to the temporary directory."), basename);
+                                    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 does not end normally."), basename);
+                            EV_DOCUMENT_ERROR,
+                            EV_DOCUMENT_ERROR_INVALID,
+                            _("The command “%s” did not end normally."),
+                            basename);
                g_free (std_out);
        }
        g_free (basename);
@@ -157,123 +188,67 @@ comics_decompress_temp_dir (const gchar       *command_decompress_tmp,
  * this information */
 static gboolean 
 comics_generate_command_lines (ComicsDocument *comics_document, 
-                              GError        **error)
+                              GError         **error)
 {
        gchar *quoted_file;
-       gchar *command_decompress_tmp, *checksum;
+       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;
+       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;
+       comics_document->offset = command_usage_def[type].offset;
+       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);
-               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) {
-                       g_set_error (error,
-                               EV_DOCUMENT_ERROR,
-                               EV_DOCUMENT_ERROR_INVALID,
-                               _("Failed to create a directory %s in the "
-                                 "temporary directory: %s"), 
-                                 comics_document->dir, 
-                                 g_strerror (errno));
-                       g_free (quoted_file);
-                       return FALSE;
+               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;
+                       }
                }
-               
-               command_decompress_tmp = g_strdup_printf ( "%s -xf %s %s", 
-                                       comics_document->selected_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);
+               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);
                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 
  * book based on its mime tipe. */
 static gboolean 
 comics_check_decompress_command        (gchar          *mime_type, 
-                               ComicsDocument  *comics_document,
-                               GError         **error)
+                                ComicsDocument *comics_document,
+                                GError         **error)
 {
        gboolean success;
        gchar *std_out, *std_err;
@@ -296,27 +271,30 @@ comics_check_decompress_command   (gchar          *mime_type,
                * option as unrar-free. 
                * */
                comics_document->selected_command = 
-                               g_find_program_in_path ("unrar");
+                                       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);
+                       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;
+                               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;
@@ -325,23 +303,43 @@ 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 */
-               comics_document->selected_command = 
+                  !strcmp (mime_type, "application/x-7z-compressed")) {
+               /* 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)
-                       return TRUE;
+                       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 {
                g_set_error (error,
                             EV_DOCUMENT_ERROR,
@@ -354,7 +352,7 @@ comics_check_decompress_command     (gchar          *mime_type,
                             EV_DOCUMENT_ERROR,
                             EV_DOCUMENT_ERROR_INVALID,
                             _("Can't find an appropiate command to "
-                              "decompress this type of comic book"));
+                            "decompress this type of comic book"));
        return FALSE;
 }
 
@@ -367,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;
@@ -382,9 +380,9 @@ comics_document_load (EvDocument *document,
                        g_propagate_error (error, err);
                } else {
                        g_set_error_literal (error,
-                                             EV_DOCUMENT_ERROR,
-                                             EV_DOCUMENT_ERROR_INVALID,
-                                             _("Unknown MIME Type"));
+                                            EV_DOCUMENT_ERROR,
+                                            EV_DOCUMENT_ERROR_INVALID,
+                                            _("Unknown MIME Type"));
                }
 
                return FALSE;
@@ -416,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,
@@ -428,26 +426,35 @@ comics_document_load (EvDocument *document,
        }
 
        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])),
+                                       g_strdup (g_strstrip (cb_file)),
                                        (GCompareFunc) strcmp);
                        comics_document->n_pages++;
                }
-
                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);
 
@@ -459,7 +466,6 @@ comics_document_load (EvDocument *document,
                             uri);
                return FALSE;
        }
-
        return TRUE;
 }
 
@@ -497,8 +503,7 @@ comics_document_get_page_size (EvDocument *document,
        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 | 
@@ -538,10 +543,10 @@ comics_document_get_page_size (EvDocument *document,
                g_object_unref (loader);
        } else {
                filename = g_build_filename (comics_document->dir,      
-                                               (char*) g_slist_nth_data (
-                                               comics_document->page_names, 
-                                               page->index),
-                                               NULL);
+                                            (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)
@@ -575,7 +580,7 @@ comics_document_render_pixbuf (EvDocument      *document,
        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 | 
@@ -610,22 +615,21 @@ comics_document_render_pixbuf (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 (
+               filename = 
+                       g_build_filename (comics_document->dir,
+                                         (char*) g_slist_nth_data (
                                                comics_document->page_names, 
-                                               rc->page->index ),
-                                       NULL);
+                                               rc->page->index),
+                                         NULL);
           
-               gdk_pixbuf_get_file_info (filename, &width, &height);                                                                   
+               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);                                      
+               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;
@@ -675,8 +679,9 @@ comics_remove_dir (gchar *path_name)
                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);
+                       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);
@@ -693,31 +698,25 @@ 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_warning (_("There was an error deleting “%s”."),
+                                  comics_document->dir);
                g_free (comics_document->dir);
+               g_remove (ev_tmp_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);
        }
 
-       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);
 }