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