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
 252                 for (i = 0; i < priv->n_pages; i++) {
 253                         EvPage     *page = ev_document_get_page (document, i);
 254                         gdouble     page_width = 0;
 255                         gdouble     page_height = 0;
 256                         EvPageSize *page_size;
 257                         gchar      *page_label;
 258
 259                         _ev_document_get_page_size (document, page, &page_width, &page_height);
 260
 261                         if (i == 0) {
 262                                 priv->uniform_width = page_width;
 263                                 priv->uniform_height = page_height;
 264                                 priv->max_width = priv->uniform_width;
 265                                 priv->max_height = priv->uniform_height;
 266                         } else if (priv->uniform &&
 267                                    (priv->uniform_width != page_width ||
 268                                     priv->uniform_height != page_height)) {
 269                                 /* It's a different page size.  Backfill the array. */
 270                                 int j;
 271
 272                                 priv->page_sizes = g_new0 (EvPageSize, priv->n_pages);
 273
 274                                 for (j = 0; j < i; j++) {
 275                                         page_size = &(priv->page_sizes[j]);
 276                                         page_size->width = priv->uniform_width;
 277                                         page_size->height = priv->uniform_height;
 278                                 }
 279                                 priv->uniform = FALSE;
 280                         }
 281                         if (!priv->uniform) {
 282                                 page_size = &(priv->page_sizes[i]);
 283
 284                                 page_size->width = page_width;
 285                                 page_size->height = page_height;
 286
 287                                 if (page_width > priv->max_width)
 288                                         priv->max_width = page_width;
 289
 290                                 if (page_height > priv->max_height)
 291                                         priv->max_height = page_height;
 292                         }
 293
 294                         page_label = _ev_document_get_page_label (document, page);
 295                         if (page_label) {
 296                                 if (!priv->page_labels)
 297                                         priv->page_labels = g_new0 (gchar *, priv->n_pages);
 298
 299                                 priv->page_labels[i] = page_label;
 300                                 priv->max_label = MAX (priv->max_label,
 301                                                        g_utf8_strlen (page_label, 256));
 302                         }
 303
 304                         g_object_unref (page);
 305                 }
 306
 307                 priv->info = _ev_document_get_info (document);
 308         }
 309
 310         return retval;
 311 }
 312
 313 /**
 314  * ev_document_save:
 315  * @document:
 316  * @uri: the target URI
 317  * @error: a #GError location to store an error, or %NULL
 318  *
 319  * Saves @document to @uri.
 320  *
 321  * Returns: %TRUE on success, or %FALSE on error with @error filled in
 322  */
 323 gboolean
 324 ev_document_save (EvDocument  *document,
 325                   const char  *uri,
 326                   GError     **error)
 327 {
 328         EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 329
 330         return klass->save (document, uri, error);
 331 }
 332
 333 EvPage *
 334 ev_document_get_page (EvDocument *document,
 335                       gint        index)
 336 {
 337         EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 338
 339         return klass->get_page (document, index);
 340 }
 341
 342 static gint
 343 _ev_document_get_n_pages (EvDocument  *document)
 344 {
 345         EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 346
 347         return klass->get_n_pages (document);
 348 }
 349
 350 gint
 351 ev_document_get_n_pages (EvDocument  *document)
 352 {
 353         g_return_val_if_fail (EV_IS_DOCUMENT (document), 0);
 354
 355         return document->priv->n_pages;
 356 }
 357
 358 static void
 359 _ev_document_get_page_size (EvDocument *document,
 360                             EvPage     *page,
 361                             double     *width,
 362                             double     *height)
 363 {
 364         EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 365
 366         klass->get_page_size (document, page, width, height);
 367 }
 368
 369 void
 370 ev_document_get_page_size (EvDocument *document,
 371                            gint        page_index,
 372                            double     *width,
 373                            double     *height)
 374 {
 375         g_return_if_fail (EV_IS_DOCUMENT (document));
 376         g_return_if_fail (page_index >= 0 || page_index < document->priv->n_pages);
 377
 378         if (width)
 379                 *width = document->priv->uniform ?
 380                         document->priv->uniform_width :
 381                         document->priv->page_sizes[page_index].width;
 382         if (height)
 383                 *height = document->priv->uniform ?
 384                         document->priv->uniform_height :
 385                         document->priv->page_sizes[page_index].height;
 386 }
 387
 388 static gchar *
 389 _ev_document_get_page_label (EvDocument *document,
 390                              EvPage     *page)
 391 {
 392         EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 393
 394         return klass->get_page_label ?
 395                 klass->get_page_label (document, page) : NULL;
 396 }
 397
 398 gchar *
 399 ev_document_get_page_label (EvDocument *document,
 400                             gint        page_index)
 401 {
 402         g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
 403         g_return_val_if_fail (page_index >= 0 || page_index < document->priv->n_pages, NULL);
 404
 405         return (document->priv->page_labels && document->priv->page_labels[page_index]) ?
 406                 g_strdup (document->priv->page_labels[page_index]) :
 407                 g_strdup_printf ("%d", page_index + 1);
 408 }
 409
 410 static EvDocumentInfo *
 411 _ev_document_get_info (EvDocument *document)
 412 {
 413         EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 414
 415         return klass->get_info (document);
 416 }
 417
 418 EvDocumentInfo *
 419 ev_document_get_info (EvDocument *document)
 420 {
 421         g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
 422
 423         return document->priv->info;
 424 }
 425
 426 cairo_surface_t *
 427 ev_document_render (EvDocument      *document,
 428                     EvRenderContext *rc)
 429 {
 430         EvDocumentClass *klass = EV_DOCUMENT_GET_CLASS (document);
 431
 432         return klass->render (document, rc);
 433 }
 434
 435 const gchar *
 436 ev_document_get_uri (EvDocument *document)
 437 {
 438         g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
 439
 440         return document->priv->uri;
 441 }
 442
 443 const gchar *
 444 ev_document_get_title (EvDocument *document)
 445 {
 446         g_return_val_if_fail (EV_IS_DOCUMENT (document), NULL);
 447
 448         return (document->priv->info->fields_mask & EV_DOCUMENT_INFO_TITLE) ?
 449                 document->priv->info->title : NULL;
 450 }
 451
 452 gboolean
 453 ev_document_is_page_size_uniform (EvDocument *document)
 454 {
 455         g_return_val_if_fail (EV_IS_DOCUMENT (document), TRUE);
 456
 457         return document->priv->uniform;
 458 }
 459
 460 void
 461 ev_document_get_max_page_size (EvDocument *document,
 462                                gdouble    *width,
 463                                gdouble    *height)
 464 {
 465         g_return_if_fail (EV_IS_DOCUMENT (document));
 466
 467         if (width)
 468                 *width = document->priv->max_width;
 469         if (height)
 470                 *height = document->priv->max_height;
 471 }
 472
 473 gboolean
 474 ev_document_check_dimensions (EvDocument *document)
 475 {
 476         g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
 477
 478         return (document->priv->max_width > 0 && document->priv->max_height > 0);
 479 }
 480
 481 gint
 482 ev_document_get_max_label_len (EvDocument *document)
 483 {
 484         g_return_val_if_fail (EV_IS_DOCUMENT (document), -1);
 485
 486         return document->priv->max_label;
 487 }
 488
 489 gboolean
 490 ev_document_has_text_page_labels (EvDocument *document)
 491 {
 492         g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
 493
 494         return document->priv->page_labels != NULL;
 495 }
 496
 497 gboolean
 498 ev_document_find_page_by_label (EvDocument  *document,
 499                                 const gchar *page_label,
 500                                 gint        *page_index)
 501 {
 502         gint i, page;
 503         glong value;
 504         gchar *endptr = NULL;
 505         EvDocumentPrivate *priv = document->priv;
 506
 507         g_return_val_if_fail (EV_IS_DOCUMENT (document), FALSE);
 508         g_return_val_if_fail (page_label != NULL, FALSE);
 509         g_return_val_if_fail (page_index != NULL, FALSE);
 510
 511         /* First, look for a literal label match */
 512         for (i = 0; priv->page_labels && i < priv->n_pages; i ++) {
 513                 if (priv->page_labels[i] != NULL &&
 514                     ! strcmp (page_label, priv->page_labels[i])) {
 515                         *page_index = i;
 516                         return TRUE;
 517                 }
 518         }
 519
 520         /* Second, look for a match with case insensitively */
 521         for (i = 0; priv->page_labels && i < priv->n_pages; i++) {
 522                 if (priv->page_labels[i] != NULL &&
 523                     ! strcasecmp (page_label, priv->page_labels[i])) {
 524                         *page_index = i;
 525                         return TRUE;
 526                 }
 527         }
 528
 529         /* Next, parse the label, and see if the number fits */
 530         value = strtol (page_label, &endptr, 10);
 531         if (endptr[0] == '\0') {
 532                 /* Page number is an integer */
 533                 page = MIN (G_MAXINT, value);
 534
 535                 /* convert from a page label to a page offset */
 536                 page --;
 537                 if (page >= 0 && page < priv->n_pages) {
 538                         *page_index = page;
 539                         return TRUE;
 540                 }
 541         }
 542
 543         return FALSE;
 544 }
 545
 546 /* EvDocumentInfo */
 547 EV_DEFINE_BOXED_TYPE (EvDocumentInfo, ev_document_info, ev_document_info_copy, ev_document_info_free)
 548
 549 EvDocumentInfo *
 550 ev_document_info_copy (EvDocumentInfo *info)
 551 {
 552         EvDocumentInfo *copy;
 553
 554         g_return_val_if_fail (info != NULL, NULL);
 555
 556         copy = g_new0 (EvDocumentInfo, 1);
 557         copy->title = g_strdup (info->title);
 558         copy->format = g_strdup (info->format);
 559         copy->author = g_strdup (info->author);
 560         copy->subject = g_strdup (info->subject);
 561         copy->keywords = g_strdup (info->keywords);
 562         copy->security = g_strdup (info->security);
 563         copy->creator = g_strdup (info->creator);
 564         copy->producer = g_strdup (info->producer);
 565         copy->linearized = g_strdup (info->linearized);
 566
 567         copy->creation_date = info->creation_date;
 568         copy->modified_date = info->modified_date;
 569         copy->layout = info->layout;
 570         copy->mode = info->mode;
 571         copy->ui_hints = info->ui_hints;
 572         copy->permissions = info->permissions;
 573         copy->n_pages = info->n_pages;
 574         copy->license = ev_document_license_copy (info->license);
 575
 576         copy->fields_mask = info->fields_mask;
 577
 578         return copy;
 579 }
 580
 581 void
 582 ev_document_info_free (EvDocumentInfo *info)
 583 {
 584         if (info == NULL)
 585                 return;
 586
 587         g_free (info->title);
 588         g_free (info->format);
 589         g_free (info->author);
 590         g_free (info->subject);
 591         g_free (info->keywords);
 592         g_free (info->creator);
 593         g_free (info->producer);
 594         g_free (info->linearized);
 595         g_free (info->security);
 596         ev_document_license_free (info->license);
 597
 598         g_free (info);
 599 }
 600
 601 /* EvDocumentLicense */
 602 EV_DEFINE_BOXED_TYPE (EvDocumentLicense, ev_document_license, ev_document_license_copy, ev_document_license_free)
 603
 604 EvDocumentLicense *
 605 ev_document_license_new (void)
 606 {
 607         return g_new0 (EvDocumentLicense, 1);
 608 }
 609
 610 EvDocumentLicense *
 611 ev_document_license_copy (EvDocumentLicense *license)
 612 {
 613         EvDocumentLicense *new_license;
 614
 615         if (!license)
 616                 return NULL;
 617
 618         new_license = ev_document_license_new ();
 619
 620         if (license->text)
 621                 new_license->text = g_strdup (license->text);
 622         if (license->uri)
 623                 new_license->uri = g_strdup (license->uri);
 624         if (license->web_statement)
 625                 new_license->web_statement = g_strdup (license->web_statement);
 626
 627         return new_license;
 628 }
 629
 630 void
 631 ev_document_license_free (EvDocumentLicense *license)
 632 {
 633         if (!license)
 634                 return;
 635
 636         g_free (license->text);
 637         g_free (license->uri);
 638         g_free (license->web_statement);
 639
 640         g_free (license);
 641 }
 642
 643 const gchar *
 644 ev_document_license_get_text (EvDocumentLicense *license)
 645 {
 646         return license->text;
 647 }
 648
 649 const gchar *
 650 ev_document_license_get_uri (EvDocumentLicense *license)
 651 {
 652         return license->uri;
 653 }
 654
 655 const gchar *
 656 ev_document_license_get_web_statement (EvDocumentLicense *license)
 657 {
 658         return license->web_statement;
 659 }
 660
 661 /* EvRectangle */
 662 EV_DEFINE_BOXED_TYPE (EvRectangle, ev_rectangle, ev_rectangle_copy, ev_rectangle_free)
 663
 664 EvRectangle *
 665 ev_rectangle_new (void)
 666 {
 667         return g_new0 (EvRectangle, 1);
 668 }
 669
 670 EvRectangle *
 671 ev_rectangle_copy (EvRectangle *rectangle)
 672 {
 673         EvRectangle *new_rectangle;
 674
 675         g_return_val_if_fail (rectangle != NULL, NULL);
 676
 677         new_rectangle = g_new (EvRectangle, 1);
 678         *new_rectangle = *rectangle;
 679
 680         return new_rectangle;
 681 }
 682
 683 void
 684 ev_rectangle_free (EvRectangle *rectangle)
 685 {
 686         g_free (rectangle);
 687 }
 688
 689 /* Compares two rects.  returns 0 if they're equal */
 690 #define EPSILON 0.0000001
 691
 692 gint
 693 ev_rect_cmp (EvRectangle *a,
 694              EvRectangle *b)
 695 {
 696         if (a == b)
 697                 return 0;
 698         if (a == NULL || b == NULL)
 699                 return 1;
 700
 701         return ! ((ABS (a->x1 - b->x1) < EPSILON) &&
 702                   (ABS (a->y1 - b->y1) < EPSILON) &&
 703                   (ABS (a->x2 - b->x2) < EPSILON) &&
 704                   (ABS (a->y2 - b->y2) < EPSILON));
 705 }