Merge pull request #452 from ONLYOFFICE/feature/java-spring-refactoring-history

Feature/java spring refactoring history

web/documentserver-example/java-spring/src/main/java/com/onlyoffice/integration/controllers/EditorController.java

@@ -20,7 +20,6 @@ package com.onlyoffice.integration.controllers;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.onlyoffice.integration.documentserver.managers.history.HistoryManager;
 import com.onlyoffice.integration.documentserver.managers.jwt.JwtManager;
 import com.onlyoffice.integration.documentserver.models.enums.Action;
 import com.onlyoffice.integration.documentserver.storage.FileStoragePathBuilder;
@@ -73,9 +72,6 @@ public class EditorController {
     @Autowired
     private UserServices userService;
 
-    @Autowired
-    private HistoryManager historyManager;
-
     @Autowired
     private ObjectMapper objectMapper;
 
@@ -140,9 +136,6 @@ public class EditorController {
         // add file model with the default parameters to the original model
         model.addAttribute("model", fileModel);
 
-        // get file history and add it to the model
-        model.addAttribute("fileHistory", historyManager.getHistory(fileModel.getDocument()));
-
         // create the document service api URL and add it to the model
         model.addAttribute("docserviceApiUrl", docserviceSite + docserviceApiUrl);
 

web/documentserver-example/java-spring/src/main/java/com/onlyoffice/integration/controllers/FileController.java

@@ -22,6 +22,7 @@ import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 import com.onlyoffice.integration.documentserver.callbacks.CallbackHandler;
+import com.onlyoffice.integration.documentserver.managers.history.HistoryManager;
 import com.onlyoffice.integration.documentserver.managers.jwt.JwtManager;
 import com.onlyoffice.integration.documentserver.storage.FileStorageMutator;
 import com.onlyoffice.integration.documentserver.storage.FileStoragePathBuilder;
@@ -114,6 +115,8 @@ public class FileController {
     private ServiceConverter serviceConverter;
     @Autowired
     private CallbackManager callbackManager;
+    @Autowired
+    private HistoryManager historyManager;
 
     // create user metadata
     private String createUserMetadata(final String uid, final String fullFileName) {
@@ -538,6 +541,20 @@ public class FileController {
         }
     }
 
+    @GetMapping("/history")
+    @ResponseBody
+    public String history(@RequestParam("fileName") final String fileName) {
+        return historyManager.getHistory(fileName);
+    }
+
+    @GetMapping("/historydata")
+    @ResponseBody
+    public String history(@RequestParam("fileName") final String fileName,
+                          @RequestParam("version") final String version,
+                          @RequestParam(value = "directUrl", defaultValue = "false") final Boolean directUrl) {
+        return historyManager.getHistoryData(fileName, version, directUrl);
+    }
+
     @PutMapping("/restore")
     @ResponseBody
     public String restore(@RequestBody final JSONObject body) {

web/documentserver-example/java-spring/src/main/java/com/onlyoffice/integration/documentserver/managers/history/DefaultHistoryManager.java

@@ -25,6 +25,7 @@ import com.onlyoffice.integration.documentserver.managers.jwt.JwtManager;
 import com.onlyoffice.integration.documentserver.models.filemodel.Document;
 import com.onlyoffice.integration.documentserver.storage.FileStoragePathBuilder;
 import com.onlyoffice.integration.documentserver.util.file.FileUtility;
+import com.onlyoffice.integration.documentserver.util.service.ServiceConverter;
 import lombok.SneakyThrows;
 import org.json.simple.JSONArray;
 import org.json.simple.JSONObject;
@@ -62,6 +63,9 @@ public class DefaultHistoryManager implements HistoryManager {
     @Autowired
     private ObjectMapper objectMapper;
 
+    @Autowired
+    private ServiceConverter serviceConverter;
+
     // todo: Refactoring
     @SneakyThrows
     public String[] getHistory(final Document document) {  // get document history
@@ -164,6 +168,153 @@ public class DefaultHistoryManager implements HistoryManager {
         return new String[]{"", ""};
     }
 
+    // todo: Refactoring
+    @SneakyThrows
+    public String getHistory(final String fileName) {  // get document history
+
+        // get history directory
+        String histDir = storagePathBuilder.getHistoryDir(storagePathBuilder.getFileLocation(fileName));
+        Integer curVer = storagePathBuilder.getFileVersion(histDir, false);  // get current file version
+
+        if (curVer > 0) {  // check if the current file version is greater than 0
+            List<Object> hist = new ArrayList<>();
+
+            for (Integer i = 1; i <= curVer; i++) {  // run through all the file versions
+                Map<String, Object> obj = new HashMap<String, Object>();
+                String verDir = documentManager
+                        .versionDir(histDir, i, true);  // get the path to the given file version
+
+                String key;
+                if (i == curVer) {
+                    key = serviceConverter
+                            .generateRevisionId(storagePathBuilder.getStorageLocation()
+                                    + "/" + fileName + "/"
+                                    + new File(storagePathBuilder.getFileLocation(fileName)).lastModified());
+                } else {
+                    key = readFileToEnd(new File(verDir + File.separator + "key.txt"));
+                }
+
+                obj.put("key", key);
+                obj.put("version", i);
+
+                if (i == 1) {  // check if the version number is equal to 1
+                    String createdInfo = readFileToEnd(new File(histDir
+                            + File.separator + "createdInfo.json"));  // get file with meta data
+                    JSONObject json = (JSONObject) parser.parse(createdInfo);  // and turn it into json object
+
+                    // write meta information to the object (user information and creation date)
+                    obj.put("created", json.get("created"));
+                    Map<String, Object> user = new HashMap<String, Object>();
+                    user.put("id", json.get("id"));
+                    user.put("name", json.get("name"));
+                    obj.put("user", user);
+                }
+
+                if (i > 1) {  //check if the version number is greater than 1
+                    // if so, get the path to the changes.json file
+                    JSONObject changes = (JSONObject) parser.parse(readFileToEnd(new File(documentManager
+                            .versionDir(histDir, i - 1, true) + File.separator + "changes.json")));
+                    JSONObject change = (JSONObject) ((JSONArray) changes.get("changes")).get(0);
+
+                    // write information about changes to the object
+                    obj.put("changes", changes.get("changes"));
+                    obj.put("serverVersion", changes.get("serverVersion"));
+                    obj.put("created", change.get("created"));
+                    obj.put("user", change.get("user"));
+                }
+
+                hist.add(obj);
+            }
+
+            // write history information about the current file version to the history object
+            Map<String, Object> histObj = new HashMap<String, Object>();
+            histObj.put("currentVersion", curVer);
+            histObj.put("history", hist);
+
+            try {
+                return objectMapper.writeValueAsString(histObj);
+            } catch (JsonProcessingException e) {
+                e.printStackTrace();
+            }
+        }
+        return "";
+    }
+
+    // todo: Refactoring
+    @SneakyThrows
+    public String getHistoryData(final String fileName, final String version, final Boolean directUrl) {
+        // get history directory
+        String histDir = storagePathBuilder.getHistoryDir(storagePathBuilder.getFileLocation(fileName));
+        Integer curVer = storagePathBuilder.getFileVersion(histDir, false);  // get current file version
+
+        if (curVer > 0) {  // check if the current file version is greater than 0
+            Map<String, Object> histData = new HashMap<>();
+
+            for (Integer i = 1; i <= curVer; i++) {  // run through all the file versions
+                Map<String, Object> dataObj = new HashMap<String, Object>();
+                String verDir = documentManager
+                        .versionDir(histDir, i, true);  // get the path to the given file version
+
+                String key;
+                if (i == curVer) {
+                    key = serviceConverter
+                            .generateRevisionId(storagePathBuilder.getStorageLocation()
+                                    + "/" + fileName + "/"
+                                    + new File(storagePathBuilder.getFileLocation(fileName)).lastModified());
+                } else {
+                    key = readFileToEnd(new File(verDir + File.separator + "key.txt"));
+                }
+
+                dataObj.put("fileType", fileUtility
+                        .getFileExtension(fileName).replace(".", ""));
+                dataObj.put("key", key);
+                dataObj.put("url", i == curVer ? documentManager.getDownloadUrl(fileName, true)
+                        : documentManager.getHistoryFileUrl(fileName, i, "prev" + fileUtility
+                        .getFileExtension(fileName), true));
+                if (directUrl) {
+                    dataObj.put("directUrl", i == curVer
+                            ? documentManager.getDownloadUrl(fileName, false)
+                            : documentManager.getHistoryFileUrl(fileName, i, "prev" + fileUtility
+                                    .getFileExtension(fileName), false));
+                }
+                dataObj.put("version", i);
+
+                if (i > 1) {  //check if the version number is greater than 1
+                    // get the history data from the previous file version
+                    Map<String, Object> prev = (Map<String, Object>) histData.get(Integer.toString(i - 1));
+                    Map<String, Object> prevInfo = new HashMap<String, Object>();
+                    prevInfo.put("fileType", prev.get("fileType"));
+                    prevInfo.put("key", prev.get("key"));  // write key and URL information about previous file version
+                    prevInfo.put("url", prev.get("url"));
+                    if (directUrl) {
+                        prevInfo.put("directUrl", prev.get("directUrl"));
+                    }
+
+                    // write information about previous file version to the data object
+                    dataObj.put("previous", prevInfo);
+                    // write the path to the diff.zip archive with differences in this file version
+                    Integer verdiff = i - 1;
+                    dataObj.put("changesUrl", documentManager
+                            .getHistoryFileUrl(fileName, verdiff, "diff.zip", true));
+                }
+
+                if (jwtManager.tokenEnabled()) {
+                    dataObj.put("token", jwtManager.createToken(dataObj));
+                }
+
+                histData.put(Integer.toString(i), dataObj);
+            }
+
+            try {
+                return objectMapper.writeValueAsString(histData.get(version));
+            } catch (JsonProcessingException e) {
+                e.printStackTrace();
+            }
+        }
+        return "";
+    }
+
+
     // read a file
     private String readFileToEnd(final File file) {
         String output = "";

web/documentserver-example/java-spring/src/main/java/com/onlyoffice/integration/documentserver/managers/history/HistoryManager.java

@@ -18,9 +18,9 @@
 
 package com.onlyoffice.integration.documentserver.managers.history;
 
-import com.onlyoffice.integration.documentserver.models.filemodel.Document;
-
 // specify the history manager functions
 public interface HistoryManager {
-    String[] getHistory(Document document);  // get document history
+    String getHistory(String fileName);  // get document history
+
+    String getHistoryData(String fileName, String version, Boolean directUrl); // get document history data
 }

web/documentserver-example/java-spring/src/main/resources/templates/editor.html

@@ -172,6 +172,36 @@
                     }
                 };
 
+                var onRequestHistory = function () {
+                    var xhr = new XMLHttpRequest();
+                    xhr.open("GET", "history?fileName=" + config.document.title, false);
+                    xhr.send();
+
+                    if (xhr.status == 200) {
+                        var historyInfo = JSON.parse(xhr.responseText);
+                        docEditor.refreshHistory(historyInfo);
+                    }
+                };
+
+                var onRequestHistoryData = function (event) {
+                    var version = event.data;
+                    var historyDataUri = "historydata?fileName=" + config.document.title
+                        + "&version=" + version
+                        + "&directUrl=" + !!config.document.directUrl;
+                    var xhr = new XMLHttpRequest();
+                    xhr.open("GET", historyDataUri, false);
+                    xhr.send();
+
+                    if (xhr.status == 200) {
+                        var historyData = JSON.parse(xhr.responseText);
+                        docEditor.setHistoryData(historyData);
+                    }
+                };
+
+                var onRequestHistoryClose = function() {
+                    document.location.reload();
+                };
+
                 function onRequestRestore(event) {
                   const query = new URLSearchParams(window.location.search)
                   const config = [[${model}]]
@@ -185,12 +215,20 @@
                   request.setRequestHeader('Content-Type', 'application/json')
                   request.send(JSON.stringify(payload))
                   request.onload = function () {
-                    if (request.status != 200) {
-                      response = JSON.parse(request.response)
-                      innerAlert(response.error)
-                      return
+                    const response = JSON.parse(request.responseText);
+                    if (response.success && !response.error) {
+                      var historyInfoUri = "history?fileName=" + config.document.title;
+                      var xhr = new XMLHttpRequest();
+                      xhr.open("GET", historyInfoUri, false);
+                      xhr.send();
+
+                      if (xhr.status == 200) {
+                          var historyInfo = JSON.parse(xhr.responseText);
+                          docEditor.refreshHistory(historyInfo);
+                      }
+                    } else {
+                      innerAlert(response.error);
                     }
-                    document.location.reload()
                   }
                 }
 
@@ -206,31 +244,15 @@
                     "onRequestInsertImage": onRequestInsertImage,
                     "onRequestCompareFile": onRequestCompareFile,
                     "onRequestMailMergeRecipients": onRequestMailMergeRecipients,
-                    "onRequestRestore": onRequestRestore
+                    "onRequestRestore": onRequestRestore,
+                    "onRequestHistory": onRequestHistory,
+                    "onRequestHistoryData": onRequestHistoryData,
+                    "onRequestHistoryClose": onRequestHistoryClose
                 };
 
-                var histArray = [[${fileHistory}]];
-                var hist = histArray[0];
-                var historyData = histArray[1];
                 var usersForMentions = [[${usersForMentions}]];
 
                 if (config.editorConfig.user.id != 4) {
-                    if (hist && historyData) {
-                        // the user is trying to show the document version history
-                        config.events['onRequestHistory'] = function () {
-                            docEditor.refreshHistory(JSON.parse(hist));  // show the document version history
-                        };
-                        // the user is trying to click the specific document version in the document version history
-                        config.events['onRequestHistoryData'] = function (event) {
-                            var ver = event.data;
-                            var histData = historyData;
-                            docEditor.setHistoryData(JSON.parse(histData)[ver - 1]);  // send the link to the document for viewing the version history
-                        };
-                        // the user is trying to go back to the document from viewing the document version history
-                        config.events['onRequestHistoryClose'] = function () {
-                            document.location.reload();
-                        };
-                    }
                     // add mentions for not anonymous users
                     config.events['onRequestUsers'] = function () {
                         docEditor.setUsers({  // set a list of users to mention in the comments