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