EXM-44317, #16: Added an option to limit the number of revised dates.

Author: DunaMariusCosmin

i18n/translation.xml

@@ -41,6 +41,14 @@
 		<val lang="nl_NL">Map</val>
 	</key>
 
+    <key value="prolog.updater.limit.revised.dates.to">
+		<comment>The text from check box which enable to limit the added revised dates</comment>
+		<val lang="en_US">Limit the number of revised dates to</val>
+		<val lang="de_DE">Limit the number of revised dates to</val>
+		<val lang="fr_FR">Limit the number of revised dates to</val>
+		<val lang="ja_JP">Limit the number of revised dates to</val>
+		<val lang="nl_NL">Limit the number of revised dates to</val>
+	</key>
 	<key value="prolog.updater.enable.on.save">
 		<comment>The text from check box which enable the prolog update</comment>
 		<val lang="en_US">Enable automatic prolog update on save</val>

src/main/java/com/oxygenxml/prolog/updater/DitaPrologUpdater.java

@@ -51,7 +51,7 @@ public void updateProlog(final WSEditor wsEditor, final boolean isNewDocument) {
 		WSEditorPage currentPage = wsEditor.getCurrentPage();
 
 		// create a PrologContentCreator
-		PrologContentCreator prologContentCreater = new PrologContentCreator(getAuthorName(), getDateFormat());
+		PrologContentCreator prologContentCreater = new PrologContentCreator(getAuthorName(), getDateFormat(), getMaxNoOfRevisedElements());
 
 		final DitaEditor[] ditaEditor = new DitaEditor[1];
 		if (currentPage instanceof WSAuthorEditorPage) {
@@ -117,6 +117,24 @@ protected String getDateFormat() {
 	}
 
 	/**
+	 * Get the maximum number of allowed revised elements.
+	 * @return
+	 */
+	protected int getMaxNoOfRevisedElements() {
+    int max = -1;
+    PluginWorkspace pluginWorkspace = PluginWorkspaceProvider.getPluginWorkspace();
+    if(pluginWorkspace != null) {
+      WSOptionsStorage optionsStorage = pluginWorkspace.getOptionsStorage();
+      String shouldLimit =  optionsStorage.getOption(OptionKeys.LIMIT_REVISED_ELEMENTS, String.valueOf(false));
+      if(Boolean.valueOf(shouldLimit)) {
+        String value = optionsStorage.getOption(OptionKeys.MAX_REVISED_ELEMENTS, String.valueOf(-1));
+        max = Integer.valueOf(value);
+      }
+    }
+    return max;
+  }
+
+  /**
 	 * Show a warning message("The prolog wasn't updated") in results manager.
 	 * @param wsEditor The workspace editor access.
 	 */

src/main/java/com/oxygenxml/prolog/updater/dita/editor/DitaTopicAuthorEditor.java

@@ -3,6 +3,7 @@
 import java.util.List;
 
 import javax.swing.text.BadLocationException;
+import javax.swing.text.Position;
 
 import org.apache.log4j.Logger;
 
@@ -101,6 +102,7 @@ public boolean updateProlog(boolean isNewDocument) {
 				// Get the prolog element.
 				AuthorElement prolog = getPrologElement(rootElement);
 
+				documentController.beginCompoundEdit();
 				try {
 					if (prolog != null) {
 						// Prolog element exists; edit this element.
@@ -111,7 +113,9 @@ public boolean updateProlog(boolean isNewDocument) {
 					}
 				} catch (AuthorOperationException e) {
 					toReturn = false;
-				}
+				} finally {
+				  documentController.endCompoundEdit();
+        }
 			}
 		} else {
 			toReturn = false;
@@ -334,9 +338,59 @@ private void addRevisedElement(AuthorElement critdatesElement) throws AuthorOper
 			}
 			// Now insert it.
 			AuthorPageDocumentUtil.insertFragmentSchemaAware(page, documentController, fragment, offset);
+			deleteExtraRevisedElements(critdatesElement);
 		}
 	}
 
+	 /**
+   * Delete the first revised elements if the number of them is greater than allowed number.
+   * 
+   * @param critdatesElement The parent of revised elements.
+   */
+  private void deleteExtraRevisedElements(AuthorElement critdatesElement) {
+    int noOfAllowedElements = prologCreator.getMaxNoOfRevisedElement();
+    if(noOfAllowedElements != -1) {
+      List<AuthorElement> allRevisedElements = AuthorPageDocumentUtil.findElementsByClass(
+          critdatesElement, XmlElementsConstants.REVISED_DATE_ELEMENT_CLASS);
+      int noOfElements = allRevisedElements.size();
+    
+      // Get the caret position
+      Position caretPosition = null;
+      if (page instanceof WSAuthorEditorPage) {
+        try {
+          caretPosition = documentController.createPositionInContent(
+              ((WSAuthorEditorPage)page).getCaretOffset());
+        } catch (BadLocationException e) {
+          logger.error(e, e);
+        }
+      }
+      
+      if(noOfElements > noOfAllowedElements) {
+        int nuOfElementToDelete = noOfElements - noOfAllowedElements;
+        for (int i = 0; i < nuOfElementToDelete; i++) {
+          AuthorElement currentRevised = allRevisedElements.get(i);
+          // Get the previous node
+          try {
+            AuthorNode previousSibling = documentController.getNodeAtOffset(currentRevised.getStartOffset() - 1);
+            // We will delete the previous sibling if it's a comment
+            if (previousSibling.getType() == AuthorNode.NODE_TYPE_COMMENT) {
+              documentController.deleteNode(previousSibling);
+            }
+          } catch (BadLocationException e) {
+            logger.debug(e.getMessage(), e);
+          }
+          // Delete the revised element.
+          documentController.deleteNode(currentRevised);
+        }
+        
+        // Restore the caret position
+        if(caretPosition != null) {
+          ((WSAuthorEditorPage)page).setCaretPosition(caretPosition.getOffset());
+        }
+      }
+    }
+  }
+
 	/**
 	 * Update the document adding the names of the authors.
 	 * 

src/main/java/com/oxygenxml/prolog/updater/dita/editor/DitaTopicTextEditor.java

@@ -1,5 +1,7 @@
 package com.oxygenxml.prolog.updater.dita.editor;
 
+import javax.swing.text.BadLocationException;
+
 import org.apache.log4j.Logger;
 
 import com.oxygenxml.prolog.updater.prolog.content.PrologContentCreator;
@@ -74,6 +76,7 @@ public boolean updateProlog(boolean isNewDocument) {
 		boolean toReturn = true;
 		// get the prolog element
 		WSXMLTextNodeRange[] prologs;
+		wsTextEditorPage.beginCompoundUndoableEdit();
 		try {
 			prologs = wsTextEditorPage.findElementsByXPath(ElementXPathUtils.getPrologXpath(documentType));
 			// The document doesn't have a prolog element
@@ -92,7 +95,9 @@ public boolean updateProlog(boolean isNewDocument) {
 			toReturn = false;
 		} catch (TextOperationException e) {
 			toReturn = false;
-		}
+		} finally {
+      wsTextEditorPage.endCompoundUndoableEdit();
+    }
 
 		return toReturn;
 	}
@@ -205,23 +210,97 @@ private void editCritdates(boolean isNewDocument) throws XPathException, TextOpe
 			}
 		} else {
 			// it's not a new document
-			// search for revised elements that have local date as modified and have
-			// contributor as comment
-			StringBuilder xPathBuilder = new StringBuilder();
-			xPathBuilder.append(ElementXPathUtils.getCritdatesXpath(documentType));
-			xPathBuilder.append("/revised[@modified = '" ).append(prologCreator.getLocalDate()).append("']/");
-			xPathBuilder.append("preceding-sibling::node()[2][.='").append(prologCreator.getAuthor()).append("']");
-			Object[] revisedElements = wsTextEditorPage.findElementsByXPath(xPathBuilder.toString());
-
-			// if the element wasn't found
-			if (revisedElements.length == 0) {
-				// add revised xml fragament
-				TextPageDocumentUtil.insertXmlFragment(wsTextEditorPage, prologCreator.getRevisedDateFragment(documentType),
-						ElementXPathUtils.getCritdatesXpath(documentType), RelativeInsertPosition.INSERT_LOCATION_AS_LAST_CHILD);
-			}
+		  addRevisedElement();
 		}
 	}
 
+	/**
+   * Add the revised element if it doesn't exits.
+   * 
+	 * @throws XPathException 
+	 * @throws TextOperationException 
+   */
+  private void addRevisedElement() throws XPathException, TextOperationException{
+    // Search for revised elements that have local date as modified and
+    // contributor as comment
+    StringBuilder xPathBuilder = new StringBuilder();
+    xPathBuilder.append(ElementXPathUtils.getCritdatesXpath(documentType));
+    xPathBuilder.append("/revised[@modified = '" ).append(prologCreator.getLocalDate()).append("']/");
+    xPathBuilder.append("preceding-sibling::node()[2][.='").append(prologCreator.getAuthor()).append("']");
+    Object[] revisedElements = wsTextEditorPage.findElementsByXPath(xPathBuilder.toString());
+
+    // if the element wasn't found
+    if (revisedElements.length == 0) {
+      // add revised xml fragament
+      TextPageDocumentUtil.insertXmlFragment(wsTextEditorPage, prologCreator.getRevisedDateFragment(documentType),
+          ElementXPathUtils.getCritdatesXpath(documentType), RelativeInsertPosition.INSERT_LOCATION_AS_LAST_CHILD);
+      
+      deleteExtraRevisedElements();
+    }
+  }
+
+  /**
+   * Delete the first revised elements if the number of them is greater than allowed number.
+   * 
+   * @throws XPathException
+   */
+  private void deleteExtraRevisedElements() throws XPathException {
+    int noOfAllowedElements = prologCreator.getMaxNoOfRevisedElement();
+    if(noOfAllowedElements != -1) {
+      WSXMLTextNodeRange[] allRevisedElements = wsTextEditorPage.findElementsByXPath(
+          ElementXPathUtils.getCritdatesXpath(documentType) + "/revised");
+      
+      int noOfElements = allRevisedElements.length;
+      if(noOfElements > noOfAllowedElements) {
+        int nuOfElementToDelete = noOfElements - noOfAllowedElements;
+        // We will delete some revised elements
+        for (int i = 0; i < nuOfElementToDelete; i++) {
+          WSXMLTextNodeRange currentElementRange = allRevisedElements[i];
+          deleteRevisedElement(currentElementRange);
+        }
+      }
+    }
+  }
+
+  /**
+   * Delete the revised element with the given range.
+   * 
+   * @param revisedElementRange The range of revised element to delete.
+   */
+  private void deleteRevisedElement(WSXMLTextNodeRange revisedElementRange) {
+    try {
+      int startLineOffset = wsTextEditorPage.getOffsetOfLineStart(revisedElementRange.getStartLine());
+      
+      // We will calculate the offset where we start to delete and the length
+      int startOffsetToDelete = startLineOffset + (revisedElementRange.getStartColumn() - 1);
+      int lengthToDelete =  revisedElementRange.getEndColumn() - revisedElementRange.getStartColumn();
+      
+      // Check the text before revised element. This will be deleted if it's whitespace.
+      String testFromStart = wsTextEditorPage.getDocument().getText(
+          startLineOffset, revisedElementRange.getStartColumn() - 1);
+      if(testFromStart.trim().isEmpty()) {
+        startOffsetToDelete = startLineOffset - 1;
+        lengthToDelete += testFromStart.length() + 1;
+
+        // In this case we can have a comment above with the author. We also want to delete it.
+        int aboveLineStartOffset = wsTextEditorPage.getOffsetOfLineStart(revisedElementRange.getStartLine() - 1);
+        int aboveLineEndOffset = wsTextEditorPage.getOffsetOfLineEnd(revisedElementRange.getStartLine() - 1);
+        String aboveLineContet = wsTextEditorPage.getDocument().getText(
+            aboveLineStartOffset, aboveLineEndOffset - aboveLineStartOffset);
+
+        if(aboveLineContet.trim().startsWith("<!--") && aboveLineContet.trim().endsWith("-->")) {
+          startOffsetToDelete = aboveLineStartOffset;
+          lengthToDelete += aboveLineContet.length();
+        }
+      }
+      
+      wsTextEditorPage.getDocument().remove(startOffsetToDelete, lengthToDelete);
+    } catch (BadLocationException e) {
+     logger.debug(e, e);
+    }
+  }
+
+	
 	/**
 	 * Update the author elements of prolog.
 	 * 

src/main/java/com/oxygenxml/prolog/updater/prolog/content/PrologContentCreator.java

@@ -100,15 +100,32 @@ public class PrologContentCreator {
 	 */
 	private boolean updateMapRevisedDate = true;
 
+	/**
+	 * The maximum number of revised elements
+	 */
+  private int maxNoOfRevised = -1;
+
+  /**
+   * Constructor.
+   * 
+   * @param author      The name of the author.
+   * @param dateFormat  The format of the date.
+   */
+  public PrologContentCreator(String author, String dateFormat) {
+    this(author, dateFormat, -1);
+  }
+  
 	/**
 	 * Constructor.
 	 * 
 	 * @param author      The name of the author.
 	 * @param dateFormat 	The format of the date.
+	 * @param maxNoOfRevisedElements The maximum allowed number of revised elements.
 	 */
-	public PrologContentCreator(String author, String dateFormat) {
+	public PrologContentCreator(String author, String dateFormat, int maxNoOfRevisedElements) {
 		this.authorName = author;
-
+		this.maxNoOfRevised = maxNoOfRevisedElements;
+		
 		if (authorName != null) {
 			// Creator
 			creatorFragment = XMLFragmentUtils.createAuthorFragment(authorName, XmlElementsConstants.CREATOR_TYPE);
@@ -299,6 +316,14 @@ public String getDateFragment(boolean isNewDocument, DocumentType documentType)
 		return isNewDocument ? getCreatedDateFragment(documentType) : getRevisedDateFragment(documentType);
 	}
 
+	/**
+	 * The maximum number of allowed revised elements.
+	 * @return
+	 */
+	public int getMaxNoOfRevisedElement() {
+	  return maxNoOfRevised;
+	}
+	
 	/**
 	 * Create the local date.
 	 * 

src/main/java/com/oxygenxml/prolog/updater/tags/OptionKeys.java

@@ -23,6 +23,16 @@ private OptionKeys() {
 	 */
 	public static final String DATE_FORMAT = "prolog.updater.date.format";
 
+  /**
+   * Option for limit the revised elements.
+   */
+  public static final String LIMIT_REVISED_ELEMENTS = "limit.revised.elements";
+  
+	/**
+   * Option for the maximum number of revised elements.
+   */
+  public static final String MAX_REVISED_ELEMENTS = "max.revised.elements";
+  
 	/**
 	 * Option to enable the prolog updater for topics.
 	 */

src/main/java/com/oxygenxml/prolog/updater/tags/Tags.java

@@ -65,4 +65,9 @@ private Tags() {
 	 */
 	public static final String ERROR_MESSAGE = "prolog.updater.error.message";
 
+	/**
+	 * en: Limit the number of revised dates to
+	 */
+  public static final String LIMIT_REVISED_DATES_TO = "prolog.updater.limit.revised.dates.to";
+
 }