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 <libgnomevfs/gnome-vfs-mime-utils.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                 G_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         gchar *list_files_command = NULL, *std_out, *quoted_file, *mime_type;
 113         gchar **cbr_files;
 114         gboolean success;
 115         int i, retval;
 116
 117         comics_document->archive = g_filename_from_uri (uri, NULL, error);
 118         g_return_val_if_fail (comics_document->archive != NULL, FALSE);
 119
 120         quoted_file = g_shell_quote (comics_document->archive);
 121         mime_type = gnome_vfs_get_mime_type (uri);
 122
 123         /* FIXME, use proper cbr/cbz mime types once they're
 124          * included in shared-mime-info */
 125         if (!strcmp (mime_type, "application/x-cbr")) {
 126                 comics_document->extract_command =
 127                         g_strdup ("unrar p -c- -ierr");
 128                 list_files_command =
 129                         g_strdup_printf ("unrar vb -c- -- %s", quoted_file);
 130                 comics_document->regex_arg = FALSE;
 131         } else if (!strcmp (mime_type, "application/x-cbz")) {
 132                 comics_document->extract_command =
 133                         g_strdup ("unzip -p -C");
 134                 list_files_command =
 135                         g_strdup_printf ("zipinfo -1 -- %s", quoted_file);
 136                 comics_document->regex_arg = TRUE;
 137         }
 138
 139         g_free (quoted_file);
 140
 141         /* Get list of files in archive */
 142         success = g_spawn_command_line_sync (list_files_command,
 143                                              &std_out, NULL, &retval, error);
 144         g_free (list_files_command);
 145
 146         if (!success) {
 147                 g_free (mime_type);
 148                 return FALSE;
 149         } else if (retval != 0) {
 150                 g_set_error (error,
 151                              EV_DOCUMENT_ERROR,
 152                              EV_DOCUMENT_ERROR_INVALID,
 153                              _("File corrupted."));
 154                 g_free (mime_type);
 155                 return FALSE;
 156         }
 157
 158         cbr_files = g_strsplit (std_out, "\n", 0);
 159         supported_extensions = get_supported_image_extensions ();
 160         for (i = 0; cbr_files[i] != NULL; i++) {
 161                 gchar *suffix = g_strrstr (cbr_files[i], ".");
 162                 if (!suffix)
 163                         continue;
 164                 suffix = g_ascii_strdown (suffix + 1, -1);
 165
 166                 if (g_slist_find_custom (supported_extensions, suffix,
 167                                          (GCompareFunc) strcmp) != NULL) {
 168                         comics_document->page_names =
 169                                 g_slist_insert_sorted (
 170                                         comics_document->page_names,
 171                                         g_strdup (g_strstrip (cbr_files[i])),
 172                                         (GCompareFunc) strcmp);
 173                         comics_document->n_pages++;
 174                 }
 175
 176                 g_free (suffix);
 177         }
 178
 179         g_free (std_out);
 180         g_free (mime_type);
 181         g_strfreev (cbr_files);
 182         g_slist_foreach (supported_extensions, (GFunc) g_free, NULL);
 183         g_slist_free (supported_extensions);
 184
 185         if (comics_document->n_pages == 0) {
 186                 g_set_error (error,
 187                              EV_DOCUMENT_ERROR,
 188                              EV_DOCUMENT_ERROR_INVALID,
 189                              _("No images found in archive %s"),
 190                              uri);
 191                 return FALSE;
 192         }
 193
 194         return TRUE;
 195 }
 196
 197
 198 static gboolean
 199 comics_document_save (EvDocument *document,
 200                       const char *uri,
 201                       GError    **error)
 202 {
 203         ComicsDocument *comics_document = COMICS_DOCUMENT (document);
 204
 205         return ev_xfer_uri_simple (comics_document->archive, uri, error);
 206 }
 207
 208 static int
 209 comics_document_get_n_pages (EvDocument *document)
 210 {
 211         return COMICS_DOCUMENT (document)->n_pages;
 212 }
 213
 214 static void
 215 comics_document_get_page_size (EvDocument *document,
 216                                int         page,
 217                                double     *width,
 218                                double     *height)
 219 {
 220         GdkPixbufLoader *loader;
 221         char **argv;
 222         guchar buf[1024];
 223         gboolean success, got_size = FALSE;
 224         gint outpipe = -1;
 225         GPid child_pid = -1;
 226
 227         argv = extract_argv (document, page);
 228         success = g_spawn_async_with_pipes (NULL, argv, NULL,
 229                                             G_SPAWN_SEARCH_PATH | G_SPAWN_STDERR_TO_DEV_NULL,
 230                                             NULL, NULL,
 231                                             &child_pid,
 232                                             NULL, &outpipe, NULL, NULL);
 233         g_strfreev (argv);
 234         g_return_if_fail (success == TRUE);
 235
 236         loader = gdk_pixbuf_loader_new ();
 237         g_signal_connect (loader, "area-prepared",
 238                           G_CALLBACK (get_page_size_area_prepared_cb),
 239                           &got_size);
 240
 241         while (outpipe >= 0) {
 242                 gssize bytes = read (outpipe, buf, 1024);
 243
 244                 if (bytes > 0)
 245                         gdk_pixbuf_loader_write (loader, buf, bytes, NULL);
 246                 if (bytes <= 0 || got_size) {
 247                         close (outpipe);
 248                         outpipe = -1;
 249                         gdk_pixbuf_loader_close (loader, NULL);
 250                 }
 251         }
 252
 253         if (gdk_pixbuf_loader_get_pixbuf (loader)) {
 254                 GdkPixbuf *pixbuf = gdk_pixbuf_loader_get_pixbuf (loader);
 255                 if (width)
 256                         *width = gdk_pixbuf_get_width (pixbuf);
 257                 if (height)
 258                         *height = gdk_pixbuf_get_height (pixbuf);
 259         }
 260
 261         g_spawn_close_pid (child_pid);
 262         g_object_unref (loader);
 263 }
 264
 265 static void
 266 get_page_size_area_prepared_cb (GdkPixbufLoader *loader,
 267                                 gpointer         data)
 268 {
 269         gboolean *got_size = data;
 270         *got_size = TRUE;
 271 }
 272
 273 static GdkPixbuf *
 274 comics_document_render_pixbuf (EvDocument      *document,
 275                                EvRenderContext *rc)
 276 {
 277         GdkPixbufLoader *loader;
 278         GdkPixbuf *rotated_pixbuf;
 279         char **argv;
 280         guchar buf[4096];
 281         gboolean success;
 282         gint outpipe = -1;
 283         GPid child_pid = -1;
 284
 285         argv = extract_argv (document, rc->page);
 286         success = g_spawn_async_with_pipes (NULL, argv, NULL,
 287                                             G_SPAWN_SEARCH_PATH
 288                                             | G_SPAWN_STDERR_TO_DEV_NULL,
 289                                             NULL, NULL,
 290                                             &child_pid,
 291                                             NULL, &outpipe, NULL, NULL);
 292         g_strfreev (argv);
 293         g_return_val_if_fail (success == TRUE, NULL);
 294
 295         loader = gdk_pixbuf_loader_new ();
 296         g_signal_connect (loader, "size-prepared",
 297                           G_CALLBACK (render_pixbuf_size_prepared_cb), &rc->scale);
 298
 299         while (outpipe >= 0) {
 300                 gssize bytes = read (outpipe, buf, 4096);
 301
 302                 if (bytes > 0) {
 303                         gdk_pixbuf_loader_write (loader, buf, bytes, NULL);
 304                 } else if (bytes <= 0) {
 305                         close (outpipe);
 306                         gdk_pixbuf_loader_close (loader, NULL);
 307                         outpipe = -1;
 308                 }
 309         }
 310
 311         rotated_pixbuf = gdk_pixbuf_rotate_simple (gdk_pixbuf_loader_get_pixbuf (loader),
 312                                                    360 - rc->rotation);
 313         g_spawn_close_pid (child_pid);
 314         g_object_unref (loader);
 315
 316         return rotated_pixbuf;
 317 }
 318
 319 static cairo_surface_t *
 320 comics_document_render (EvDocument      *document,
 321                         EvRenderContext *rc)
 322 {
 323         GdkPixbuf       *pixbuf;
 324         cairo_surface_t *surface;
 325
 326         pixbuf = comics_document_render_pixbuf (document, rc);
 327         surface = ev_document_misc_surface_from_pixbuf (pixbuf);
 328         g_object_unref (pixbuf);
 329
 330         return surface;
 331 }
 332
 333 static void
 334 render_pixbuf_size_prepared_cb (GdkPixbufLoader *loader,
 335                                 gint             width,
 336                                 gint             height,
 337                                 gpointer         data)
 338 {
 339         double *scale = data;
 340         int w = (width  * (*scale) + 0.5);
 341         int h = (height * (*scale) + 0.5);
 342
 343         gdk_pixbuf_loader_set_size (loader, w, h);
 344 }
 345
 346 static void
 347 comics_document_finalize (GObject *object)
 348 {
 349         ComicsDocument *comics_document = COMICS_DOCUMENT (object);
 350
 351         if (comics_document->archive)
 352                 g_free (comics_document->archive);
 353
 354         if (comics_document->page_names) {
 355                 g_slist_foreach (comics_document->page_names,
 356                                  (GFunc) g_free, NULL);
 357                 g_slist_free (comics_document->page_names);
 358         }
 359
 360         if (comics_document->extract_command)
 361                 g_free (comics_document->extract_command);
 362
 363         G_OBJECT_CLASS (comics_document_parent_class)->finalize (object);
 364 }
 365
 366 static void
 367 comics_document_class_init (ComicsDocumentClass *klass)
 368 {
 369         GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 370         gobject_class->finalize = comics_document_finalize;
 371 }
 372
 373 static EvDocumentInfo *
 374 comics_document_get_info (EvDocument *document)
 375 {
 376         EvDocumentInfo *info;
 377         info = g_new0 (EvDocumentInfo, 1);
 378         return info;
 379 }
 380
 381 static void
 382 comics_document_document_iface_init (EvDocumentIface *iface)
 383 {
 384         iface->load = comics_document_load;
 385         iface->save = comics_document_save;
 386         iface->get_n_pages = comics_document_get_n_pages;
 387         iface->get_page_size = comics_document_get_page_size;
 388         iface->render = comics_document_render;
 389         iface->get_info = comics_document_get_info;
 390 }
 391
 392 static void
 393 comics_document_init (ComicsDocument *comics_document)
 394 {
 395         comics_document->archive = NULL;
 396         comics_document->page_names = NULL;
 397         comics_document->extract_command = NULL;
 398         comics_document->n_pages = 0;
 399 }
 400
 401 /* Returns a list of file extensions supported by gdk-pixbuf */
 402 static GSList*
 403 get_supported_image_extensions()
 404 {
 405         GSList *extensions = NULL;
 406         GSList *formats = gdk_pixbuf_get_formats ();
 407         GSList *l;
 408
 409         for (l = formats; l != NULL; l = l->next) {
 410                 int i;
 411                 gchar **ext = gdk_pixbuf_format_get_extensions (l->data);
 412
 413                 for (i = 0; ext[i] != NULL; i++) {
 414                         extensions = g_slist_append (extensions,
 415                                                      g_strdup (ext[i]));
 416                 }
 417
 418                 g_strfreev (ext);
 419         }
 420
 421         g_slist_free (formats);
 422         return extensions;
 423 }
 424
 425 static GdkPixbuf *
 426 comics_document_thumbnails_get_thumbnail (EvDocumentThumbnails *document,
 427                                           EvRenderContext      *rc,
 428                                           gboolean              border)
 429 {
 430         GdkPixbuf *thumbnail;
 431
 432         thumbnail = comics_document_render_pixbuf (EV_DOCUMENT (document), rc);
 433
 434         if (border) {
 435               GdkPixbuf *tmp_pixbuf = thumbnail;
 436
 437               thumbnail = ev_document_misc_get_thumbnail_frame (-1, -1, tmp_pixbuf);
 438               g_object_unref (tmp_pixbuf);
 439         }
 440
 441         return thumbnail;
 442 }
 443
 444 static void
 445 comics_document_thumbnails_get_dimensions (EvDocumentThumbnails *document,
 446                                            EvRenderContext      *rc,
 447                                            gint                 *width,
 448                                            gint                 *height)
 449 {
 450         gdouble page_width, page_height;
 451
 452         comics_document_get_page_size (EV_DOCUMENT (document), rc->page,
 453                                        &page_width, &page_height);
 454
 455         if (rc->rotation == 90 || rc->rotation == 270) {
 456                 *width = (gint) (page_height * rc->scale);
 457                 *height = (gint) (page_width * rc->scale);
 458         } else {
 459                 *width = (gint) (page_width * rc->scale);
 460                 *height = (gint) (page_height * rc->scale);
 461         }
 462 }
 463
 464 static void
 465 comics_document_document_thumbnails_iface_init (EvDocumentThumbnailsIface *iface)
 466 {
 467         iface->get_thumbnail = comics_document_thumbnails_get_thumbnail;
 468         iface->get_dimensions = comics_document_thumbnails_get_dimensions;
 469 }
 470
 471 static char**
 472 extract_argv (EvDocument *document, gint page)
 473 {
 474         ComicsDocument *comics_document = COMICS_DOCUMENT (document);
 475         char **argv;
 476         char *command_line, *quoted_archive, *quoted_filename;
 477         GError *err = NULL;
 478
 479         quoted_archive = g_shell_quote (comics_document->archive);
 480         if (comics_document->regex_arg) {
 481                 quoted_filename = comics_regex_quote (
 482                         g_slist_nth_data (comics_document->page_names, page));
 483         } else {
 484                 quoted_filename = g_shell_quote (
 485                         g_slist_nth_data (comics_document->page_names, page));
 486         }
 487
 488         command_line = g_strdup_printf ("%s -- %s %s",
 489                                         comics_document->extract_command,
 490                                         quoted_archive,
 491                                         quoted_filename);
 492
 493         g_shell_parse_argv (command_line, NULL, &argv, &err);
 494
 495         if (err) {
 496                 g_warning ("Error %s", err->message);
 497                 return NULL;
 498         }
 499
 500         g_free (command_line);
 501         g_free (quoted_archive);
 502         g_free (quoted_filename);
 503         return argv;
 504 }