modules/xmp_metadata.js

  1. /** ====================================================================
  2.  * @license
  3.  * jsPDF XMP metadata plugin
  4.  * Copyright (c) 2016 Jussi Utunen, u-jussi@suomi24.fi
  5.  *
  6.  * Permission is hereby granted, free of charge, to any person obtaining
  7.  * a copy of this software and associated documentation files (the
  8.  * "Software"), to deal in the Software without restriction, including
  9.  * without limitation the rights to use, copy, modify, merge, publish,
  10.  * distribute, sublicense, and/or sell copies of the Software, and to
  11.  * permit persons to whom the Software is furnished to do so, subject to
  12.  * the following conditions:
  13.  *
  14.  * The above copyright notice and this permission notice shall be
  15.  * included in all copies or substantial portions of the Software.
  16.  *
  17.  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18.  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19.  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  20.  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  21.  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  22.  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  23.  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24.  * ====================================================================
  25.  */
  27. import { jsPDF } from "../jspdf.js";
  29. /**
  30.  * @name xmp_metadata
  31.  * @module
  32.  */
  33. (function(jsPDFAPI) {
  34.   "use strict";
  36.   var postPutResources = function() {
  37.     var xmpmeta_beginning = '<x:xmpmeta xmlns:x="adobe:ns:meta/">';
  38.     var rdf_beginning =
  39.       '<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"><rdf:Description rdf:about="" xmlns:jspdf="' +
  40.       this.internal.__metadata__.namespaceuri +
  41.       '"><jspdf:metadata>';
  42.     var rdf_ending = "</jspdf:metadata></rdf:Description></rdf:RDF>";
  43.     var xmpmeta_ending = "</x:xmpmeta>";
  44.     var utf8_xmpmeta_beginning = unescape(
  45.       encodeURIComponent(xmpmeta_beginning)
  46.     );
  47.     var utf8_rdf_beginning = unescape(encodeURIComponent(rdf_beginning));
  48.     var utf8_metadata = unescape(
  49.       encodeURIComponent(this.internal.__metadata__.metadata)
  50.     );
  51.     var utf8_rdf_ending = unescape(encodeURIComponent(rdf_ending));
  52.     var utf8_xmpmeta_ending = unescape(encodeURIComponent(xmpmeta_ending));
  54.     var total_len =
  55.       utf8_rdf_beginning.length +
  56.       utf8_metadata.length +
  57.       utf8_rdf_ending.length +
  58.       utf8_xmpmeta_beginning.length +
  59.       utf8_xmpmeta_ending.length;
  61.     this.internal.__metadata__.metadata_object_number = this.internal.newObject();
  62.     this.internal.write(
  63.       "<< /Type /Metadata /Subtype /XML /Length " + total_len + " >>"
  64.     );
  65.     this.internal.write("stream");
  66.     this.internal.write(
  67.       utf8_xmpmeta_beginning +
  68.         utf8_rdf_beginning +
  69.         utf8_metadata +
  70.         utf8_rdf_ending +
  71.         utf8_xmpmeta_ending
  72.     );
  73.     this.internal.write("endstream");
  74.     this.internal.write("endobj");
  75.   };
  77.   var putCatalog = function() {
  78.     if (this.internal.__metadata__.metadata_object_number) {
  79.       this.internal.write(
  80.         "/Metadata " +
  81.           this.internal.__metadata__.metadata_object_number +
  82.           " 0 R"
  83.       );
  84.     }
  85.   };
  87.   /**
  88.    * Adds XMP formatted metadata to PDF
  89.    *
  90.    * @name addMetadata
  91.    * @function
  92.    * @param {String} metadata The actual metadata to be added. The metadata shall be stored as XMP simple value. Note that if the metadata string contains XML markup characters "<", ">" or "&", those characters should be written using XML entities.
  93.    * @param {String} namespaceuri Sets the namespace URI for the metadata. Last character should be slash or hash.
  94.    * @returns {jsPDF} jsPDF-instance
  95.    */
  96.   jsPDFAPI.addMetadata = function(metadata, namespaceuri) {
  97.     if (typeof this.internal.__metadata__ === "undefined") {
  98.       this.internal.__metadata__ = {
  99.         metadata: metadata,
  100.         namespaceuri: namespaceuri || "http://jspdf.default.namespaceuri/"
  101.       };
  102.       this.internal.events.subscribe("putCatalog", putCatalog);
  104.       this.internal.events.subscribe("postPutResources", postPutResources);
  105.     }
  106.     return this;
  107.   };
  108. })(jsPDF.API);