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