[Editor] Add the possibility to update an existing annotation with so…

…me new properties when saving or printing

src/core/annotation.js

@@ -264,6 +264,9 @@ class AnnotationFactory {
     const promises = [];
 
     for (const annotation of annotations) {
+      if (annotation.deleted) {
+        continue;
+      }
       switch (annotation.annotationType) {
         case AnnotationEditorType.FREETEXT:
           if (!baseFontRef) {
@@ -308,6 +311,9 @@ class AnnotationFactory {
     const { isOffscreenCanvasSupported } = evaluator.options;
     const promises = [];
     for (const annotation of annotations) {
+      if (annotation.deleted) {
+        continue;
+      }
       switch (annotation.annotationType) {
         case AnnotationEditorType.FREETEXT:
           promises.push(
@@ -466,6 +472,7 @@ class Annotation {
     const MK = dict.get("MK");
     this.setBorderAndBackgroundColors(MK);
     this.setRotation(MK);
+    this.ref = params.ref instanceof Ref ? params.ref : null;
 
     this._streams = [];
     if (this.appearance) {
@@ -1467,7 +1474,7 @@ class MarkupAnnotation extends Annotation {
   }
 
   static async createNewAnnotation(xref, annotation, dependencies, params) {
-    const annotationRef = xref.getNewTemporaryRef();
+    const annotationRef = annotation.ref || xref.getNewTemporaryRef();
     const ap = await this.createNewAppearanceStream(annotation, xref, params);
     const buffer = [];
     let annotationDict;
@@ -1497,11 +1504,17 @@ class MarkupAnnotation extends Annotation {
     const ap = await this.createNewAppearanceStream(annotation, xref, params);
     const annotationDict = this.createNewDict(annotation, xref, { ap });
 
-    return new this.prototype.constructor({
+    const newAnnotation = new this.prototype.constructor({
       dict: annotationDict,
       xref,
       isOffscreenCanvasSupported: params.isOffscreenCanvasSupported,
     });
+
+    if (annotation.ref) {
+      newAnnotation.ref = newAnnotation.refToReplace = annotation.ref;
+    }
+
+    return newAnnotation;
   }
 }
 
@@ -1511,7 +1524,6 @@ class WidgetAnnotation extends Annotation {
 
     const { dict, xref } = params;
     const data = this.data;
-    this.ref = params.ref;
     this._needAppearances = params.needAppearances;
 
     data.annotationType = AnnotationType.WIDGET;

src/core/document.js

@@ -41,7 +41,7 @@ import {
   XRefEntryException,
   XRefParseException,
 } from "./core_utils.js";
-import { Dict, isName, Name, Ref } from "./primitives.js";
+import { Dict, isName, isRefsEqual, Name, Ref, RefSet } from "./primitives.js";
 import { getXfaFontDict, getXfaFontName } from "./xfa_fonts.js";
 import { BaseStream } from "./base_stream.js";
 import { calculateMD5 } from "./crypto.js";
@@ -258,6 +258,22 @@ class Page {
     );
   }
 
+  async replaceIdByRef(annotations, deletedAnnotations) {
+    let idToRefMap = null;
+    for (const annotation of annotations) {
+      if (annotation.id) {
+        idToRefMap ||= await this._idToRefMap;
+        const ref = idToRefMap.get(annotation.id);
+        if (annotation.deleted) {
+          deletedAnnotations.put(ref);
+          continue;
+        }
+        annotation.ref = ref;
+        delete annotation.id;
+      }
+    }
+  }
+
   async saveNewAnnotations(handler, task, annotations) {
     if (this.xfaFactory) {
       throw new Error("XFA: Cannot save new annotations.");
@@ -276,8 +292,13 @@ class Page {
       options: this.evaluatorOptions,
     });
 
+    const deletedAnnotations = new RefSet();
+    await this.replaceIdByRef(annotations, deletedAnnotations);
+
     const pageDict = this.pageDict;
-    const annotationsArray = this.annotations.slice();
+    const annotationsArray = this.annotations.filter(
+      a => !deletedAnnotations.has(a)
+    );
     const newData = await AnnotationFactory.saveNewAnnotations(
       partialEvaluator,
       task,
@@ -401,15 +422,21 @@ class Page {
     const newAnnotationsByPage = !this.xfaFactory
       ? getNewAnnotationsMap(annotationStorage)
       : null;
+    const deletedAnnotations = new RefSet();
 
     let newAnnotationsPromise = Promise.resolve(null);
     if (newAnnotationsByPage) {
       const newAnnotations = newAnnotationsByPage.get(this.pageIndex);
       if (newAnnotations) {
-        newAnnotationsPromise = AnnotationFactory.printNewAnnotations(
-          partialEvaluator,
-          task,
-          newAnnotations
+        newAnnotationsPromise = this.replaceIdByRef(
+          newAnnotations,
+          deletedAnnotations
+        ).then(() =>
+          AnnotationFactory.printNewAnnotations(
+            partialEvaluator,
+            task,
+            newAnnotations
+          )
         );
       }
     }
@@ -446,6 +473,23 @@ class Page {
       newAnnotationsPromise,
     ]).then(function ([pageOpList, annotations, newAnnotations]) {
       if (newAnnotations) {
+        // Some annotations can already exist (if it has the refToReplace
+        // property). In this case, we replace the old annotation by the new
+        // one.
+        annotations = annotations.filter(a => !deletedAnnotations.has(a.ref));
+        for (let i = 0, ii = newAnnotations.length; i < ii; i++) {
+          const newAnnotation = newAnnotations[i];
+          if (newAnnotation.refToReplace) {
+            const j = annotations.findIndex(
+              a => a.ref && isRefsEqual(a.ref, newAnnotation.refToReplace)
+            );
+            if (j >= 0) {
+              annotations.splice(j, 1, newAnnotation);
+              newAnnotations.splice(i--, 1);
+              ii--;
+            }
+          }
+        }
         annotations = annotations.concat(newAnnotations);
       }
       if (
@@ -688,6 +732,20 @@ class Page {
     return shadow(this, "_parsedAnnotations", parsedAnnotations);
   }
 
+  get _idToRefMap() {
+    const promise = this._parsedAnnotations.then(annotations => {
+      const idToRefMap = new Map();
+      for (const annotation of annotations) {
+        if (!annotation?.ref) {
+          continue;
+        }
+        idToRefMap.set(annotation.data.id, annotation.ref);
+      }
+      return idToRefMap;
+    });
+    return shadow(this, "_idToRefMap", promise);
+  }
+
   get jsActions() {
     const actions = collectActions(
       this.xref,

test/pdfs/.gitignore

@@ -598,3 +598,4 @@
 !issue16473.pdf
 !bug1529502.pdf
 !issue16500.pdf
+!freetexts.pdf