libdocument/ev-document.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; c-indent-level: 8 -*- */
   2 /*
   3  *  Copyright (C) 2009 Carlos Garcia Campos
   4  *  Copyright (C) 2004 Marco Pesenti Gritti
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2, or (at your option)
   9  *  any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19  *
  20  */
  21
  22 #include "config.h"
  23
  24 #include <stdlib.h>
  25 #include <string.h>
  26
  27 #include "ev-document.h"
  28
  29 #define EV_DOCUMENT_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), EV_TYPE_DOCUMENT, EvDocumentPrivate))
  30
  31 typedef struct _EvPageSize
  32 {
  33         gdouble width;
  34         gdouble height;
  35 } EvPageSize;
  36
  37 struct _EvDocumentPrivate
  38 {
  39         gchar          *uri;
  40
  41         gint            n_pages;
  42
  43         gboolean        uniform;
  44         gdouble         uniform_width;
  45         gdouble         uniform_height;
  46
  47         gdouble         max_width;
  48         gdouble         max_height;
  49         gint            max_label;
  50
  51         gchar         **page_labels;
  52         EvPageSize     *page_sizes;
  53         EvDocumentInfo *info;
  54 };
  55
  56 static gint            _ev_document_get_n_pages   (EvDocument  *document);
  57 static void            _ev_document_get_page_size (EvDocument *document,
  58                                                    EvPage     *page,
  59                                                    double     *width,
  60                                                    double     *height);
  61 static gchar          *_ev_document_get_page_label (EvDocument *document,
  62                                                     EvPage     *page);
  63 static EvDocumentInfo *_ev_document_get_info       (EvDocument *document);
  64
  65 GMutex *ev_doc_mutex = NULL;
  66 GMutex *ev_fc_mutex = NULL;
  67
  68 G_DEFINE_ABSTRACT_TYPE (EvDocument, ev_document, G_TYPE_OBJECT)
  69
  70 GQuark
  71 ev_document_error_quark (void)
  72 {
  73   static GQuark q = 0;
  74   if (q == 0)
  75     q = g_quark_from_static_string ("ev-document-error-quark");
  76
  77   return q;
  78 }
  79
  80 static EvPage *
  81 ev_document_impl_get_page (EvDocument *document,
  82                            gint        index)
  83 {
  84         return ev_page_new (index);
  85 }
  86
  87 static EvDocumentInfo *
  88 ev_document_impl_get_info (EvDocument *document)
  89 {
  90         return g_new0 (EvDocumentInfo, 1);
  91 }
  92
  93 static void
  94 ev_document_finalize (GObject *object)
  95 {
  96         EvDocument *document = EV_DOCUMENT (object);
  97
  98         if (document->priv->uri) {
  99                 g_free (document->priv->uri);
 100                 document->priv->uri = NULL;
 101         }
 102
 103         if (document->priv->page_sizes) {
 104                 g_free (document->priv->page_sizes);
 105                 document->priv->page_sizes = NULL;
 106         }
 107
 108         if (document->priv->page_labels) {
 109                 gint i;
 110
 111                 for (i = 0; i < document->priv->n_pages; i++) {
 112                         g_free (document->priv->page_labels[i]);
 113                 }
 114                 g_free (document->priv->page_labels);
 115                 document->priv->page_labels = NULL;
 116         }
 117
 118         if (document->priv->info) {
 119                 ev_document_info_free (document->priv->info);
 120                 document->priv->info = NULL;
 121         }
 122
 123         G_OBJECT_CLASS (ev_document_parent_class)->finalize (object);
 124 }
 125
 126 static void
 127 ev_document_init (EvDocument *document)
 128 {
 129         document->priv = EV_DOCUMENT_GET_PRIVATE (document);
 130
 131         /* Assume all pages are the same size until proven otherwise */
 132         document->priv->uniform = TRUE;
 133 }
 134
 135 static void
 136 ev_document_class_init (EvDocumentClass *klass)
 137 {
 138         GObjectClass *g_object_class = G_OBJECT_CLASS (klass);
 139
 140         g_type_class_add_private (g_object_class, sizeof (EvDocumentPrivate));
 141
 142         klass->get_page = ev_document_impl_get_page;
 143         klass->get_info = ev_document_impl_get_info;
 144
 145         g_object_class->finalize = ev_document_finalize;
 146 }
 147
 148 GMutex *
 149 ev_document_get_doc_mutex (void)
 150 {
 151         if (ev_doc_mutex == NULL) {
 152                 ev_doc_mutex = g_mutex_new ();
 153         }
 154         return ev_doc_mutex;
 155 }
 156
 157 void
 158 ev_document_doc_mutex_lock (void)
 159 {
 160         g_mutex_lock (ev_document_get_doc_mutex ());
 161 }
 162
 163 void
 164 ev_document_doc_mutex_unlock (void)
 165 {
 166         g_mutex_unlock (ev_document_get_doc_mutex ());
 167 }
 168
 169 gboolean
 170 ev_document_doc_mutex_trylock (void)
 171 {
 172         return g_mutex_trylock (ev_document_get_doc_mutex ());
 173 }
 174
 175 GMutex *
 176 ev_document_get_fc_mutex (void)
 177 {
 178         if (ev_fc_mutex == NULL) {
 179                 ev_fc_mutex = g_mutex_new ();
 180         }
 181         return ev_fc_mutex;
 182 }
 183
 184 void
 185 ev_document_fc_mutex_lock (void)
 186 {
 187         g_mutex_lock (ev_document_get_fc_mutex ());
 188 }
 189
 190 void
 191 ev_document_fc_mutex_unlock (void)
 192 {
 193         g_mutex_unlock (ev_document_get_fc_mutex ());
 194 }
 195
 196 gboolean
 197 ev_document_fc_mutex_trylock (void)
 198 {
 199         return g_mutex_trylock (ev_document_get_fc_mutex ());
 200 }
 201
 202 /**
 203  * ev_document_load:
 204  * @document: a #EvDocument
 205  * @uri: the document's URI
 206  * @error: a #GError location to store an error, or %NULL
 207  *
 208  * Loads @document from @uri.
 209  *
 210  * On failure, %FALSE is returned and @error is filled in.
 211  * If the document is encrypted, EV_DEFINE_ERROR_ENCRYPTED is returned.
 212  * If the backend cannot load the specific document, EV_DOCUMENT_ERROR_INVALID
 213  * is returned. Other errors are possible too, depending on the backend
 214  * used to load the document and the URI, e.g. #GIOError, #GFileError, and
 215  * #GConvertError.
 216  *
 217  * Returns: %TRUE on success, or %FALSE on failure.
 218  */
 219 gboolean
 220 ev_document_load (EvDocument  *document,
 221                   const char  *uri,
 222                   GError     **error)
 223 {
 224         EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 225         gboolean retval;
 226         GError *err = NULL;
 227
 228         retval = klass->load (document, uri, &err);
 229         if (!retval) {
 230                 if (err) {
 231                         g_propagate_error (error, err);
 232                 } else {
 233                         g_warning ("%s::EvDocument::load returned FALSE but did not fill in @error; fix the backend!\n",
 234                                    G_OBJECT_TYPE_NAME (document));
 235
 236                         /* So upper layers don't crash */
 237                         g_set_error_literal (error,
 238                                              EV_DOCUMENT_ERROR,
 239                                              EV_DOCUMENT_ERROR_INVALID,
 240                                              "Internal error in backend");
 241                 }
 242         } else {
 243                 gint i;
 244                 EvDocumentPrivate *priv = document->priv;
 245
 246                 /* Cache some info about the document to avoid
 247                  * going to the backends since it requires locks
 248                  */
 249                 priv->uri = g_strdup (uri);
 250                 priv->n_pages = _ev_document_get_n_pages (document);
 251                 priv->info = _ev_document_get_info (document);
 252
 253                 for (i = 0; i < priv->n_pages; i++) {
 254                         EvPage     *page = ev_document_get_page (document, i);
 255                         gdouble     page_width = 0;
 256                         gdouble     page_height = 0;
 257                         EvPageSize *page_size;
 258                         gchar      *page_label;
 259
 260                         _ev_document_get_page_size (document, page, &page_width, &page_height);
 261
 262                         if (i == 0) {
 263                                 priv->uniform_width = page_width;
 264                                 priv->uniform_height = page_height;
 265                                 priv->max_width = priv->uniform_width;
 266                                 priv->max_height = priv->uniform_height;
 267                         } else if (priv->uniform &&
 268                                    (priv->uniform_width != page_width ||
 269                                     priv->uniform_height != page_height)) {
 270                                 /* It's a different page size.  Backfill the array. */
 271                                 int j;
 272
 273                                 priv->page_sizes = g_new0 (EvPageSize, priv->n_pages);
 274
 275                                 for (j = 0; j < i; j++) {
 276                                         page_size = &(priv->page_sizes[j]);
 277                                         page_size->width = priv->uniform_width;
 278                                         page_size->height = priv->uniform_height;
 279                                 }
 280                                 priv->uniform = FALSE;
 281                         }
 282                         if (!priv->uniform) {
 283                                 page_size = &(priv->page_sizes[i]);
 284
 285                                 page_size->width = page_width;
 286                                 page_size->height = page_height;
 287
 288                                 if (page_width > priv->max_width)
 289                                         priv->max_width = page_width;
 290
 291                                 if (page_height > priv->max_height)
 292                                         priv->max_height = page_height;
 293                         }
 294
 295                         page_label = _ev_document_get_page_label (document, page);
 296                         if (page_label) {
 297                                 if (priv->page_labels) {
 298                                         priv->page_labels[i] = page_label;
 299                                 } else {
 300                                         gchar *numeric_label;
 301
 302                                         numeric_label = g_strdup_printf ("%d", i + 1);
 303                                         if (strcmp (numeric_label, page_label) != 0) {
 304                                                 priv->page_labels = g_new0 (gchar *, priv->n_pages);
 305                                                 priv->page_labels[i] = page_label;
 306                                         }
 307                                         g_free (numeric_label);
 308                                 }
 309                                 priv->max_label = MAX (priv->max_label,
 310                                                        g_utf8_strlen (page_label, 256));
 311                         }
 312
 313                         g_object_unref (page);
 314                 }
 315         }
 316
 317         return retval;
 318 }
 319
 320 /**
 321  * ev_document_save:
 322  * @document:
 323  * @uri: the target URI
 324  * @error: a #GError location to store an error, or %NULL
 325  *
 326  * Saves @document to @uri.
 327  *
 328  * Returns: %TRUE on success, or %FALSE on error with @error filled in
 329  */
 330 gboolean
 331 ev_document_save (EvDocument  *document,
 332                   const char  *uri,
 333                   GError     **error)
 334 {
 335         EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 336
 337         return klass->save (document, uri, error);
 338 }
 339
 340 EvPage *
 341 ev_document_get_page (EvDocument *document,
 342                       gint        index)
 343 {
 344         EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 345
 346         return klass->get_page (document, index);
 347 }
 348
 349 static gint
 350 _ev_document_get_n_pages (EvDocument  *document)
 351 {
 352         EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 353
 354         return klass->get_n_pages (document);
 355 }
 356
 357 gint
 358 ev_document_get_n_pages (EvDocument  *document)
 359 {
 360         g_return_val_if_fail (EV_IS_DOCUMENT (document), 0);
 361
 362         return document->priv->n_pages;
 363 }
 364
 365 static void
 366 _ev_document_get_page_size (EvDocument *document,
 367                             EvPage     *page,
 368                             double     *width,
 369                             double     *height)
 370 {
 371         EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 372
 373         klass->get_page_size (document, page, width, height);
 374 }
 375
 376 void
 377 ev_document_get_page_size (EvDocument *document,
 378                            gint        page_index,
 379                            double     *width,
 380                            double     *height)
 381 {
 382         g_return_if_fail (EV_IS_DOCUMENT (document));
 383         g_return_if_fail (page_index >= 0 || page_index < document->priv->n_pages);
 384
 385         if (width)
 386                 *width = document->priv->uniform ?
 387                         document->priv->uniform_width :
 388                         document->priv->page_sizes[page_index].width;
 389         if (height)
 390                 *height = document->priv->uniform ?
 391                         document->priv->uniform_height :
 392                         document->priv->page_sizes[page_index].height;
 393 }
 394
 395 static gchar *
 396 _ev_document_get_page_label (EvDocument *document,
 397                              EvPage     *page)
 398 {
 399         EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 400
 401         return klass->get_page_label ?
 402                 klass->get_page_label (document, page) : NULL;
 403 }
 404
 405 gchar *
 406 ev_document_get_page_label (EvDocument *document,
 407                             gint        page_index)
 408 {
 409         g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
 410         g_return_val_if_fail (page_index >= 0 || page_index < document->priv->n_pages, NULL);
 411
 412         return (document->priv->page_labels && document->priv->page_labels[page_index]) ?
 413                 g_strdup (document->priv->page_labels[page_index]) :
 414                 g_strdup_printf ("%d", page_index + 1);
 415 }
 416
 417 static EvDocumentInfo *
 418 _ev_document_get_info (EvDocument *document)
 419 {
 420         EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 421
 422         return klass->get_info (document);
 423 }
 424
 425 EvDocumentInfo *
 426 ev_document_get_info (EvDocument *document)
 427 {
 428         g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
 429
 430         return document->priv->info;
 431 }
 432
 433 cairo_surface_t *
 434 ev_document_render (EvDocument      *document,
 435                     EvRenderContext *rc)
 436 {
 437         EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 438
 439         return klass->render (document, rc);
 440 }
 441
 442 const gchar *
 443 ev_document_get_uri (EvDocument *document)
 444 {
 445         g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
 446
 447         return document->priv->uri;
 448 }
 449
 450 const gchar *
 451 ev_document_get_title (EvDocument *document)
 452 {
 453         g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
 454
 455         return (document->priv->info->fields_mask & EV_DOCUMENT_INFO_TITLE) ?
 456                 document->priv->info->title : NULL;
 457 }
 458
 459 gboolean
 460 ev_document_is_page_size_uniform (EvDocument *document)
 461 {
 462         g_return_val_if_fail (EV_IS_DOCUMENT (document), TRUE);
 463
 464         return document->priv->uniform;
 465 }
 466
 467 void
 468 ev_document_get_max_page_size (EvDocument *document,
 469                                gdouble    *width,
 470                                gdouble    *height)
 471 {
 472         g_return_if_fail (EV_IS_DOCUMENT (document));
 473
 474         if (width)
 475                 *width = document->priv->max_width;
 476         if (height)
 477                 *height = document->priv->max_height;
 478 }
 479
 480 gboolean
 481 ev_document_check_dimensions (EvDocument *document)
 482 {
 483         g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
 484
 485         return (document->priv->max_width > 0 && document->priv->max_height > 0);
 486 }
 487
 488 gint
 489 ev_document_get_max_label_len (EvDocument *document)
 490 {
 491         g_return_val_if_fail (EV_IS_DOCUMENT (document), -1);
 492
 493         return document->priv->max_label;
 494 }
 495
 496 gboolean
 497 ev_document_has_text_page_labels (EvDocument *document)
 498 {
 499         g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
 500
 501         return document->priv->page_labels != NULL;
 502 }
 503
 504 gboolean
 505 ev_document_find_page_by_label (EvDocument  *document,
 506                                 const gchar *page_label,
 507                                 gint        *page_index)
 508 {
 509         gint i, page;
 510         glong value;
 511         gchar *endptr = NULL;
 512         EvDocumentPrivate *priv = document->priv;
 513
 514         g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
 515         g_return_val_if_fail (page_label != NULL, FALSE);
 516         g_return_val_if_fail (page_index != NULL, FALSE);
 517
 518         /* First, look for a literal label match */
 519         for (i = 0; priv->page_labels && i < priv->n_pages; i ++) {
 520                 if (priv->page_labels[i] != NULL &&
 521                     ! strcmp (page_label, priv->page_labels[i])) {
 522                         *page_index = i;
 523                         return TRUE;
 524                 }
 525         }
 526
 527         /* Second, look for a match with case insensitively */
 528         for (i = 0; priv->page_labels && i < priv->n_pages; i++) {
 529                 if (priv->page_labels[i] != NULL &&
 530                     ! strcasecmp (page_label, priv->page_labels[i])) {
 531                         *page_index = i;
 532                         return TRUE;
 533                 }
 534         }
 535
 536         /* Next, parse the label, and see if the number fits */
 537         value = strtol (page_label, &endptr, 10);
 538         if (endptr[0] == '\0') {
 539                 /* Page number is an integer */
 540                 page = MIN (G_MAXINT, value);
 541
 542                 /* convert from a page label to a page offset */
 543                 page --;
 544                 if (page >= 0 && page < priv->n_pages) {
 545                         *page_index = page;
 546                         return TRUE;
 547                 }
 548         }
 549
 550         return FALSE;
 551 }
 552
 553 /* EvDocumentInfo */
 554 EV_DEFINE_BOXED_TYPE (EvDocumentInfo, ev_document_info, ev_document_info_copy, ev_document_info_free)
 555
 556 EvDocumentInfo *
 557 ev_document_info_copy (EvDocumentInfo *info)
 558 {
 559         EvDocumentInfo *copy;
 560
 561         g_return_val_if_fail (info != NULL, NULL);
 562
 563         copy = g_new0 (EvDocumentInfo, 1);
 564         copy->title = g_strdup (info->title);
 565         copy->format = g_strdup (info->format);
 566         copy->author = g_strdup (info->author);
 567         copy->subject = g_strdup (info->subject);
 568         copy->keywords = g_strdup (info->keywords);
 569         copy->security = g_strdup (info->security);
 570         copy->creator = g_strdup (info->creator);
 571         copy->producer = g_strdup (info->producer);
 572         copy->linearized = g_strdup (info->linearized);
 573
 574         copy->creation_date = info->creation_date;
 575         copy->modified_date = info->modified_date;
 576         copy->layout = info->layout;
 577         copy->mode = info->mode;
 578         copy->ui_hints = info->ui_hints;
 579         copy->permissions = info->permissions;
 580         copy->n_pages = info->n_pages;
 581         copy->license = ev_document_license_copy (info->license);
 582
 583         copy->fields_mask = info->fields_mask;
 584
 585         return copy;
 586 }
 587
 588 void
 589 ev_document_info_free (EvDocumentInfo *info)
 590 {
 591         if (info == NULL)
 592                 return;
 593
 594         g_free (info->title);
 595         g_free (info->format);
 596         g_free (info->author);
 597         g_free (info->subject);
 598         g_free (info->keywords);
 599         g_free (info->creator);
 600         g_free (info->producer);
 601         g_free (info->linearized);
 602         g_free (info->security);
 603         ev_document_license_free (info->license);
 604
 605         g_free (info);
 606 }
 607
 608 /* EvDocumentLicense */
 609 EV_DEFINE_BOXED_TYPE (EvDocumentLicense, ev_document_license, ev_document_license_copy, ev_document_license_free)
 610
 611 EvDocumentLicense *
 612 ev_document_license_new (void)
 613 {
 614         return g_new0 (EvDocumentLicense, 1);
 615 }
 616
 617 EvDocumentLicense *
 618 ev_document_license_copy (EvDocumentLicense *license)
 619 {
 620         EvDocumentLicense *new_license;
 621
 622         if (!license)
 623                 return NULL;
 624
 625         new_license = ev_document_license_new ();
 626
 627         if (license->text)
 628                 new_license->text = g_strdup (license->text);
 629         if (license->uri)
 630                 new_license->uri = g_strdup (license->uri);
 631         if (license->web_statement)
 632                 new_license->web_statement = g_strdup (license->web_statement);
 633
 634         return new_license;
 635 }
 636
 637 void
 638 ev_document_license_free (EvDocumentLicense *license)
 639 {
 640         if (!license)
 641                 return;
 642
 643         g_free (license->text);
 644         g_free (license->uri);
 645         g_free (license->web_statement);
 646
 647         g_free (license);
 648 }
 649
 650 const gchar *
 651 ev_document_license_get_text (EvDocumentLicense *license)
 652 {
 653         return license->text;
 654 }
 655
 656 const gchar *
 657 ev_document_license_get_uri (EvDocumentLicense *license)
 658 {
 659         return license->uri;
 660 }
 661
 662 const gchar *
 663 ev_document_license_get_web_statement (EvDocumentLicense *license)
 664 {
 665         return license->web_statement;
 666 }
 667
 668 /* EvRectangle */
 669 EV_DEFINE_BOXED_TYPE (EvRectangle, ev_rectangle, ev_rectangle_copy, ev_rectangle_free)
 670
 671 EvRectangle *
 672 ev_rectangle_new (void)
 673 {
 674         return g_new0 (EvRectangle, 1);
 675 }
 676
 677 EvRectangle *
 678 ev_rectangle_copy (EvRectangle *rectangle)
 679 {
 680         EvRectangle *new_rectangle;
 681
 682         g_return_val_if_fail (rectangle != NULL, NULL);
 683
 684         new_rectangle = g_new (EvRectangle, 1);
 685         *new_rectangle = *rectangle;
 686
 687         return new_rectangle;
 688 }
 689
 690 void
 691 ev_rectangle_free (EvRectangle *rectangle)
 692 {
 693         g_free (rectangle);
 694 }
 695
 696 /* Compares two rects.  returns 0 if they're equal */
 697 #define EPSILON 0.0000001
 698
 699 gint
 700 ev_rect_cmp (EvRectangle *a,
 701              EvRectangle *b)
 702 {
 703         if (a == b)
 704                 return 0;
 705         if (a == NULL || b == NULL)
 706                 return 1;
 707
 708         return ! ((ABS (a->x1 - b->x1) < EPSILON) &&
 709                   (ABS (a->y1 - b->y1) < EPSILON) &&
 710                   (ABS (a->x2 - b->x2) < EPSILON) &&
 711                   (ABS (a->y2 - b->y2) < EPSILON));
 712 }