backend/comics/comics-document.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; c-indent-level: 8 -*- */
   2 /*
   3  * Copyright (C) 2005, Teemu Tervo <teemu.tervo@gmx.net>
   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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 #include "config.h"
  21
  22 #include <config.h>
  23 #include <unistd.h>
  24 #include <string.h>
  25 #include <glib/gi18n.h>
  26 #include <gio/gio.h>
  27
  28 #include "comics-document.h"
  29 #include "ev-document-misc.h"
  30 #include "ev-document-thumbnails.h"
  31 #include "ev-file-helpers.h"
  32
  33 struct _ComicsDocumentClass
  34 {
  35         GObjectClass parent_class;
  36 };
  37
  38 struct _ComicsDocument
  39 {
  40         GObject parent_instance;
  41
  42         gchar  *archive;
  43         GSList *page_names;
  44         int     n_pages;
  45         char   *extract_command;
  46         gboolean regex_arg;
  47 };
  48
  49 typedef struct _ComicsDocumentClass ComicsDocumentClass;
  50
  51 static void       comics_document_document_iface_init (EvDocumentIface *iface);
  52 static void       comics_document_document_thumbnails_iface_init (EvDocumentThumbnailsIface *iface);
  53
  54 static GSList*    get_supported_image_extensions (void);
  55 static void       get_page_size_area_prepared_cb (GdkPixbufLoader *loader,
  56                                                   gpointer data);
  57 static void       render_pixbuf_size_prepared_cb (GdkPixbufLoader *loader,
  58                                                   gint width,
  59                                                   gint height,
  60                                                   gpointer data);
  61 static char**     extract_argv                   (EvDocument *document,
  62                                                   gint page);
  63
  64
  65 EV_BACKEND_REGISTER_WITH_CODE (ComicsDocument, comics_document,
  66         {
  67                 EV_BACKEND_IMPLEMENT_INTERFACE (EV_TYPE_DOCUMENT_THUMBNAILS,
  68                                                 comics_document_document_thumbnails_iface_init);
  69         } );
  70
  71 static char *
  72 comics_regex_quote (const char *s)
  73 {
  74     char *ret, *d;
  75
  76     d = ret = g_malloc (strlen (s) * 4 + 3);
  77
  78     *d++ = '\'';
  79
  80     for (; *s; s++, d++) {
  81         switch (*s) {
  82         case '?':
  83         case '|':
  84         case '[':
  85         case ']':
  86         case '*':
  87         case '\\':
  88             *d++ = '\\';
  89             break;
  90         case '\'':
  91             *d++ = '\'';
  92             *d++ = '\\';
  93             *d++ = '\'';
  94             break;
  95         }
  96         *d = *s;
  97     }
  98
  99     *d++ = '\'';
 100     *d = '\0';
 101
 102     return ret;
 103 }
 104
 105 static gboolean
 106 comics_document_load (EvDocument *document,
 107                       const char *uri,
 108                       GError    **error)
 109 {
 110         ComicsDocument *comics_document = COMICS_DOCUMENT (document);
 111         GSList *supported_extensions;
 112         GFile *file;
 113         GFileInfo *file_info;
 114         gchar *list_files_command = NULL, *std_out, *quoted_file;
 115         const gchar *mime_type = NULL;
 116         gchar **cbr_files;
 117         gboolean success;
 118         int i, retval;
 119
 120         comics_document->archive = g_filename_from_uri (uri, NULL, error);
 121         g_return_val_if_fail (comics_document->archive != NULL, FALSE);
 122
 123         quoted_file = g_shell_quote (comics_document->archive);
 124         file = g_file_new_for_uri (uri);
 125         file_info = g_file_query_info (file,
 126                                        G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
 127                                        0, NULL, NULL);
 128         if (file_info != NULL) {
 129                 mime_type = g_file_info_get_content_type (file_info);
 130         }
 131         g_object_unref (file);
 132
 133         /* FIXME, use proper cbr/cbz mime types once they're
 134          * included in shared-mime-info */
 135         if (!strcmp (mime_type, "application/x-cbr")) {
 136                 comics_document->extract_command =
 137                         g_strdup ("unrar p -c- -ierr");
 138                 list_files_command =
 139                         g_strdup_printf ("unrar vb -c- -- %s", quoted_file);
 140                 comics_document->regex_arg = FALSE;
 141         } else if (!strcmp (mime_type, "application/x-cbz")) {
 142                 comics_document->extract_command =
 143                         g_strdup ("unzip -p -C");
 144                 list_files_command =
 145                         g_strdup_printf ("zipinfo -1 -- %s", quoted_file);
 146                 comics_document->regex_arg = TRUE;
 147         } else if (!strcmp (mime_type, "application/x-cb7")) {
 148                 comics_document->extract_command =
 149                         g_strdup ("7zr x -so");
 150                 list_files_command =
 151                         g_strdup_printf ("7zr l -- %s", quoted_file);
 152                 comics_document->regex_arg = TRUE;
 153         }
 154
 155         g_object_unref (file_info);
 156         g_free (quoted_file);
 157
 158         /* Get list of files in archive */
 159         success = g_spawn_command_line_sync (list_files_command,
 160                                              &std_out, NULL, &retval, error);
 161         g_free (list_files_command);
 162
 163         if (!success) {
 164                 return FALSE;
 165         } else if (retval != 0) {
 166                 g_set_error (error,
 167                              EV_DOCUMENT_ERROR,
 168                              EV_DOCUMENT_ERROR_INVALID,
 169                              _("File corrupted."));
 170                 return FALSE;
 171         }
 172
 173         cbr_files = g_strsplit (std_out, "\n", 0);
 174         supported_extensions = get_supported_image_extensions ();
 175         for (i = 0; cbr_files[i] != NULL; i++) {
 176                 gchar *suffix = g_strrstr (cbr_files[i], ".");
 177                 if (!suffix)
 178                         continue;
 179                 suffix = g_ascii_strdown (suffix + 1, -1);
 180
 181                 if (g_slist_find_custom (supported_extensions, suffix,
 182                                          (GCompareFunc) strcmp) != NULL) {
 183                         comics_document->page_names =
 184                                 g_slist_insert_sorted (
 185                                         comics_document->page_names,
 186                                         g_strdup (g_strstrip (cbr_files[i])),
 187                                         (GCompareFunc) strcmp);
 188                         comics_document->n_pages++;
 189                 }
 190
 191                 g_free (suffix);
 192         }
 193
 194         g_free (std_out);
 195         g_strfreev (cbr_files);
 196         g_slist_foreach (supported_extensions, (GFunc) g_free, NULL);
 197         g_slist_free (supported_extensions);
 198
 199         if (comics_document->n_pages == 0) {
 200                 g_set_error (error,
 201                              EV_DOCUMENT_ERROR,
 202                              EV_DOCUMENT_ERROR_INVALID,
 203                              _("No images found in archive %s"),
 204                              uri);
 205                 return FALSE;
 206         }
 207
 208         return TRUE;
 209 }
 210
 211
 212 static gboolean
 213 comics_document_save (EvDocument *document,
 214                       const char *uri,
 215                       GError    **error)
 216 {
 217         ComicsDocument *comics_document = COMICS_DOCUMENT (document);
 218
 219         return ev_xfer_uri_simple (comics_document->archive, uri, error);
 220 }
 221
 222 static int
 223 comics_document_get_n_pages (EvDocument *document)
 224 {
 225         return COMICS_DOCUMENT (document)->n_pages;
 226 }
 227
 228 static void
 229 comics_document_get_page_size (EvDocument *document,
 230                                EvPage     *page,
 231                                double     *width,
 232                                double     *height)
 233 {
 234         GdkPixbufLoader *loader;
 235         char **argv;
 236         guchar buf[1024];
 237         gboolean success, got_size = FALSE;
 238         gint outpipe = -1;
 239         GPid child_pid = -1;
 240
 241         argv = extract_argv (document, page->index);
 242         success = g_spawn_async_with_pipes (NULL, argv, NULL,
 243                                             G_SPAWN_SEARCH_PATH | G_SPAWN_STDERR_TO_DEV_NULL,
 244                                             NULL, NULL,
 245                                             &child_pid,
 246                                             NULL, &outpipe, NULL, NULL);
 247         g_strfreev (argv);
 248         g_return_if_fail (success == TRUE);
 249
 250         loader = gdk_pixbuf_loader_new ();
 251         g_signal_connect (loader, "area-prepared",
 252                           G_CALLBACK (get_page_size_area_prepared_cb),
 253                           &got_size);
 254
 255         while (outpipe >= 0) {
 256                 gssize bytes = read (outpipe, buf, 1024);
 257
 258                 if (bytes > 0)
 259                         gdk_pixbuf_loader_write (loader, buf, bytes, NULL);
 260                 if (bytes <= 0 || got_size) {
 261                         close (outpipe);
 262                         outpipe = -1;
 263                         gdk_pixbuf_loader_close (loader, NULL);
 264                 }
 265         }
 266
 267         if (gdk_pixbuf_loader_get_pixbuf (loader)) {
 268                 GdkPixbuf *pixbuf = gdk_pixbuf_loader_get_pixbuf (loader);
 269                 if (width)
 270                         *width = gdk_pixbuf_get_width (pixbuf);
 271                 if (height)
 272                         *height = gdk_pixbuf_get_height (pixbuf);
 273         }
 274
 275         g_spawn_close_pid (child_pid);
 276         g_object_unref (loader);
 277 }
 278
 279 static void
 280 get_page_size_area_prepared_cb (GdkPixbufLoader *loader,
 281                                 gpointer         data)
 282 {
 283         gboolean *got_size = data;
 284         *got_size = TRUE;
 285 }
 286
 287 static GdkPixbuf *
 288 comics_document_render_pixbuf (EvDocument      *document,
 289                                EvRenderContext *rc)
 290 {
 291         GdkPixbufLoader *loader;
 292         GdkPixbuf *rotated_pixbuf;
 293         char **argv;
 294         guchar buf[4096];
 295         gboolean success;
 296         gint outpipe = -1;
 297         GPid child_pid = -1;
 298
 299         argv = extract_argv (document, rc->page->index);
 300         success = g_spawn_async_with_pipes (NULL, argv, NULL,
 301                                             G_SPAWN_SEARCH_PATH
 302                                             | G_SPAWN_STDERR_TO_DEV_NULL,
 303                                             NULL, NULL,
 304                                             &child_pid,
 305                                             NULL, &outpipe, NULL, NULL);
 306         g_strfreev (argv);
 307         g_return_val_if_fail (success == TRUE, NULL);
 308
 309         loader = gdk_pixbuf_loader_new ();
 310         g_signal_connect (loader, "size-prepared",
 311                           G_CALLBACK (render_pixbuf_size_prepared_cb), &rc->scale);
 312
 313         while (outpipe >= 0) {
 314                 gssize bytes = read (outpipe, buf, 4096);
 315
 316                 if (bytes > 0) {
 317                         gdk_pixbuf_loader_write (loader, buf, bytes, NULL);
 318                 } else if (bytes <= 0) {
 319                         close (outpipe);
 320                         gdk_pixbuf_loader_close (loader, NULL);
 321                         outpipe = -1;
 322                 }
 323         }
 324
 325         rotated_pixbuf = gdk_pixbuf_rotate_simple (gdk_pixbuf_loader_get_pixbuf (loader),
 326                                                    360 - rc->rotation);
 327         g_spawn_close_pid (child_pid);
 328         g_object_unref (loader);
 329
 330         return rotated_pixbuf;
 331 }
 332
 333 static cairo_surface_t *
 334 comics_document_render (EvDocument      *document,
 335                         EvRenderContext *rc)
 336 {
 337         GdkPixbuf       *pixbuf;
 338         cairo_surface_t *surface;
 339
 340         pixbuf = comics_document_render_pixbuf (document, rc);
 341         surface = ev_document_misc_surface_from_pixbuf (pixbuf);
 342         g_object_unref (pixbuf);
 343
 344         return surface;
 345 }
 346
 347 static void
 348 render_pixbuf_size_prepared_cb (GdkPixbufLoader *loader,
 349                                 gint             width,
 350                                 gint             height,
 351                                 gpointer         data)
 352 {
 353         double *scale = data;
 354         int w = (width  * (*scale) + 0.5);
 355         int h = (height * (*scale) + 0.5);
 356
 357         gdk_pixbuf_loader_set_size (loader, w, h);
 358 }
 359
 360 static void
 361 comics_document_finalize (GObject *object)
 362 {
 363         ComicsDocument *comics_document = COMICS_DOCUMENT (object);
 364
 365         if (comics_document->archive)
 366                 g_free (comics_document->archive);
 367
 368         if (comics_document->page_names) {
 369                 g_slist_foreach (comics_document->page_names,
 370                                  (GFunc) g_free, NULL);
 371                 g_slist_free (comics_document->page_names);
 372         }
 373
 374         if (comics_document->extract_command)
 375                 g_free (comics_document->extract_command);
 376
 377         G_OBJECT_CLASS (comics_document_parent_class)->finalize (object);
 378 }
 379
 380 static void
 381 comics_document_class_init (ComicsDocumentClass *klass)
 382 {
 383         GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 384         gobject_class->finalize = comics_document_finalize;
 385 }
 386
 387 static EvDocumentInfo *
 388 comics_document_get_info (EvDocument *document)
 389 {
 390         EvDocumentInfo *info;
 391         info = g_new0 (EvDocumentInfo, 1);
 392         return info;
 393 }
 394
 395 static void
 396 comics_document_document_iface_init (EvDocumentIface *iface)
 397 {
 398         iface->load = comics_document_load;
 399         iface->save = comics_document_save;
 400         iface->get_n_pages = comics_document_get_n_pages;
 401         iface->get_page_size = comics_document_get_page_size;
 402         iface->render = comics_document_render;
 403         iface->get_info = comics_document_get_info;
 404 }
 405
 406 static void
 407 comics_document_init (ComicsDocument *comics_document)
 408 {
 409         comics_document->archive = NULL;
 410         comics_document->page_names = NULL;
 411         comics_document->extract_command = NULL;
 412         comics_document->n_pages = 0;
 413 }
 414
 415 /* Returns a list of file extensions supported by gdk-pixbuf */
 416 static GSList*
 417 get_supported_image_extensions()
 418 {
 419         GSList *extensions = NULL;
 420         GSList *formats = gdk_pixbuf_get_formats ();
 421         GSList *l;
 422
 423         for (l = formats; l != NULL; l = l->next) {
 424                 int i;
 425                 gchar **ext = gdk_pixbuf_format_get_extensions (l->data);
 426
 427                 for (i = 0; ext[i] != NULL; i++) {
 428                         extensions = g_slist_append (extensions,
 429                                                      g_strdup (ext[i]));
 430                 }
 431
 432                 g_strfreev (ext);
 433         }
 434
 435         g_slist_free (formats);
 436         return extensions;
 437 }
 438
 439 static GdkPixbuf *
 440 comics_document_thumbnails_get_thumbnail (EvDocumentThumbnails *document,
 441                                           EvRenderContext      *rc,
 442                                           gboolean              border)
 443 {
 444         GdkPixbuf *thumbnail;
 445
 446         thumbnail = comics_document_render_pixbuf (EV_DOCUMENT (document), rc);
 447
 448         if (border) {
 449               GdkPixbuf *tmp_pixbuf = thumbnail;
 450
 451               thumbnail = ev_document_misc_get_thumbnail_frame (-1, -1, tmp_pixbuf);
 452               g_object_unref (tmp_pixbuf);
 453         }
 454
 455         return thumbnail;
 456 }
 457
 458 static void
 459 comics_document_thumbnails_get_dimensions (EvDocumentThumbnails *document,
 460                                            EvRenderContext      *rc,
 461                                            gint                 *width,
 462                                            gint                 *height)
 463 {
 464         gdouble page_width, page_height;
 465
 466         comics_document_get_page_size (EV_DOCUMENT (document), rc->page,
 467                                        &page_width, &page_height);
 468
 469         if (rc->rotation == 90 || rc->rotation == 270) {
 470                 *width = (gint) (page_height * rc->scale);
 471                 *height = (gint) (page_width * rc->scale);
 472         } else {
 473                 *width = (gint) (page_width * rc->scale);
 474                 *height = (gint) (page_height * rc->scale);
 475         }
 476 }
 477
 478 static void
 479 comics_document_document_thumbnails_iface_init (EvDocumentThumbnailsIface *iface)
 480 {
 481         iface->get_thumbnail = comics_document_thumbnails_get_thumbnail;
 482         iface->get_dimensions = comics_document_thumbnails_get_dimensions;
 483 }
 484
 485 static char**
 486 extract_argv (EvDocument *document, gint page)
 487 {
 488         ComicsDocument *comics_document = COMICS_DOCUMENT (document);
 489         char **argv;
 490         char *command_line, *quoted_archive, *quoted_filename;
 491         GError *err = NULL;
 492
 493         quoted_archive = g_shell_quote (comics_document->archive);
 494         if (comics_document->regex_arg) {
 495                 quoted_filename = comics_regex_quote (
 496                         g_slist_nth_data (comics_document->page_names, page));
 497         } else {
 498                 quoted_filename = g_shell_quote (
 499                         g_slist_nth_data (comics_document->page_names, page));
 500         }
 501
 502         command_line = g_strdup_printf ("%s -- %s %s",
 503                                         comics_document->extract_command,
 504                                         quoted_archive,
 505                                         quoted_filename);
 506
 507         g_shell_parse_argv (command_line, NULL, &argv, &err);
 508
 509         if (err) {
 510                 g_warning ("Error %s", err->message);
 511                 return NULL;
 512         }
 513
 514         g_free (command_line);
 515         g_free (quoted_archive);
 516         g_free (quoted_filename);
 517         return argv;
 518 }