Merge pull request #56 from groupdocs-viewer/update_viewer_to_v20_7

Updated GroupDocs.Viewer to v20.7 and Angular Viewer UI to v0.8.15

Author: bobkovalex

client/package.json

@@ -36,7 +36,7 @@
     "@angular/platform-browser": "^8.2.14",
     "@angular/platform-browser-dynamic": "^8.2.14",
     "@angular/router": "^8.2.14",
-    "@groupdocs.examples.angular/viewer": "^0.5.5",
+    "@groupdocs.examples.angular/viewer": "^0.8.15",
     "@nrwl/angular": "^8.8.2",
     "core-js": "^2.5.4",
     "rxjs": "~6.4.0",

configuration.yml

@@ -87,4 +87,8 @@ viewer:
   # Print secured documents mode
   # Set false to ignore document print security
   # Set true to check document print security
-  printAllowed: true
+  printAllowed: true
+  # Set true to show grid lines
+  showGridLines: true
+  # Set cache folder name
+  cacheFolderName: cache

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.groupdocs.ui</groupId>
     <artifactId>viewer-spring</artifactId>
-    <version>1.14.32</version>
+    <version>1.14.33</version>
     <packaging>${packaging.type}</packaging>
 
     <name>GroupDocs.Viewer for Java Spring Sample</name>
@@ -128,17 +128,26 @@
             <artifactId>spring-boot-starter-thymeleaf</artifactId>
             <version>2.0.4.RELEASE</version>
         </dependency>
-
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.9.4</version>
+        </dependency>
         <dependency>
             <groupId>commons-io</groupId>
             <artifactId>commons-io</artifactId>
             <version>2.6</version>
         </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+            <version>3.4</version>
+        </dependency>
 
         <dependency>
             <groupId>com.groupdocs</groupId>
             <artifactId>groupdocs-viewer</artifactId>
-            <version>19.8.1</version>
+            <version>20.7</version>
             <type>jar</type>
         </dependency>
 

src/main/java/com/groupdocs/ui/Application.java

@@ -34,11 +34,6 @@ public static void main(String[] args) {
         SpringApplication.run(Application.class, args);
     }
 
-    @Override
-    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
-        return application.sources(Application.class);
-    }
-
     @Bean
     public static PropertySourcesPlaceholderConfigurer properties() {
         PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer = new PropertySourcesPlaceholderConfigurer();
@@ -68,9 +63,15 @@ public static YamlPropertiesFactoryBean getYamlPropertiesFactoryBean() {
         return propertiesFactoryBean;
     }
 
+    @Override
+    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
+        return application.sources(Application.class);
+    }
+
     /**
      * Configure CORS parameters
-     * @return
+     *
+     * @return Web Mvc configurer
      */
     @Bean
     public WebMvcConfigurer corsConfigurer() {

src/main/java/com/groupdocs/ui/ApplicationStartup.java

@@ -18,8 +18,7 @@ public class ApplicationStartup implements ApplicationListener<WebServerInitiali
     /**
      * This method is called during Spring's startup.
      *
-     * @param event Event raised when an ApplicationContext gets initialized or
-     * refreshed.
+     * @param event Event raised when an ApplicationContext gets initialized or refreshed.
      */
     public void onApplicationEvent(WebServerInitializedEvent event) {
         // use this event for obtaining the local port of a running server

src/main/java/com/groupdocs/ui/cache/FileViewerCache.java

@@ -0,0 +1,174 @@
+package com.groupdocs.ui.cache;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.exc.MismatchedInputException;
+import com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException;
+import com.groupdocs.ui.cache.mixin.PageMixIn;
+import com.groupdocs.ui.cache.mixin.PdfViewInfoMixIn;
+import com.groupdocs.ui.cache.mixin.ViewInfoMixIn;
+import com.groupdocs.ui.exception.DiskAccessException;
+import com.groupdocs.viewer.results.Page;
+import com.groupdocs.viewer.results.PdfViewInfo;
+import com.groupdocs.viewer.results.ViewInfo;
+import com.groupdocs.viewer.utils.PathUtils;
+import org.apache.commons.io.IOUtils;
+
+import java.io.*;
+
+public class FileViewerCache implements ViewerCache {
+    private static final ObjectMapper MAPPER = new ObjectMapper();
+    private static final long WAIT_TIMEOUT = 100L;
+
+    static {
+        MAPPER.addMixIn(ViewInfo.class, ViewInfoMixIn.class);
+        MAPPER.addMixIn(PdfViewInfo.class, PdfViewInfoMixIn.class);
+        MAPPER.addMixIn(Page.class, PageMixIn.class);
+    }
+
+    /**
+     * Gets the Relative or absolute path to the cache folder.
+     */
+    public String mCachePath;
+    /**
+     * Gets the sub-folder to append to the CachePath.
+     */
+    public String mCacheSubFolder;
+
+    /**
+     * Initializes a new instance of the FileViewerCache class.
+     *
+     * @param cachePath      or absolute path where document cache will be stored.
+     * @param cacheSubFolder sub-folder to append to cachePath.
+     */
+    public FileViewerCache(String cachePath, String cacheSubFolder) {
+        if (cachePath == null) {
+            throw new IllegalArgumentException("cachePath");
+        }
+
+        if (cacheSubFolder == null) {
+            throw new IllegalArgumentException("cacheSubFolder");
+        }
+
+        this.mCachePath = cachePath;
+        this.mCacheSubFolder = cacheSubFolder;
+    }
+
+    /**
+     * Serializes data to the local disk.
+     *
+     * @param key   An unique identifier for the cache entry.
+     * @param value The object to serialize.
+     */
+    @Override
+    public void set(String key, Object value) {
+        if (value == null) {
+            return;
+        }
+
+        String filePath = this.getCacheFilePath(key);
+        try {
+            OutputStream dst = null;
+            try {
+                if (value instanceof InputStream) {
+                    dst = this.getStream(filePath);
+                    IOUtils.copy((InputStream) value, dst);
+
+                } else {
+                    dst = this.getStream(filePath);
+                    MAPPER.writerWithDefaultPrettyPrinter().writeValue(dst, value);
+                }
+            } finally {
+                if (dst != null) {
+                    dst.close();
+                }
+            }
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    /**
+     * Deserializes data associated with this key if present.
+     *
+     * @param key A key identifying the requested entry.
+     * @return true if the key was found.
+     */
+    public <T> T getValue(String key, T defaultEntry, Class<?>[] clazzs) {
+        String cacheFilePath = this.getCacheFilePath(key);
+        if (!new File(cacheFilePath).exists()) {
+            set(key, defaultEntry);
+            return defaultEntry;
+        }
+        try {
+            for (Class<?> clazz : clazzs) {
+                final FileInputStream inputStream = new FileInputStream(cacheFilePath);
+                try {
+                    return (T) MAPPER.readValue(inputStream, clazz);
+                } catch (UnrecognizedPropertyException e) {
+                    // continue;
+                } finally {
+                    inputStream.close();
+                }
+            }
+        } catch (MismatchedInputException e) {
+            try {
+                return (T) new FileInputStream(cacheFilePath);
+            } catch (IOException ex) {
+                throw new RuntimeException(ex);
+            }
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+        return null;
+    }
+
+
+    @Override
+    public String getCacheFilePath(String key) {
+        String folderPath = PathUtils.combine(this.getCachePath(), this.getCacheSubFolder());
+        String filePath = PathUtils.combine(folderPath, key);
+
+        final File file = new File(folderPath);
+        if (!file.exists() && !file.mkdirs()) {
+            throw new DiskAccessException("create cache directory", file);
+        }
+
+        return filePath;
+    }
+
+    @Override
+    public boolean contains(String key) {
+        String file = PathUtils.combine(this.getCachePath(), this.getCacheSubFolder(), key);
+        return new File(file).exists();
+    }
+
+    private OutputStream getStream(String path) throws FileNotFoundException, InterruptedException {
+        OutputStream stream = null;
+        long totalTime = 0;
+        long interval = 50;
+        while (stream == null) {
+            try {
+                stream = new FileOutputStream(path);
+            } catch (IOException e) {
+                Thread.sleep(50);
+                totalTime += interval;
+
+                if (totalTime > WAIT_TIMEOUT) {
+                    throw e;
+                }
+            }
+        }
+
+        return stream;
+    }
+
+    @Override
+    public String getCachePath() {
+        return mCachePath;
+    }
+
+    @Override
+    public String getCacheSubFolder() {
+        return mCacheSubFolder;
+    }
+}

src/main/java/com/groupdocs/ui/cache/ViewerCache.java

@@ -0,0 +1,42 @@
+package com.groupdocs.ui.cache;
+
+/**
+ * Defines methods required for storing rendered document and document resources сache.
+ */
+public interface ViewerCache {
+    /**
+     * The Relative or absolute path to the cache folder.
+     */
+    String getCachePath();
+
+    /**
+     * The sub-folder to append to the CachePath.
+     */
+    String getCacheSubFolder();
+
+    /**
+     * Inserts a cache entry into the cache.
+     *
+     * @param key   A unique identifier for the cache entry.
+     * @param value The object to insert.
+     */
+    <T> void set(String key, T value);
+
+    /**
+     * Gets the entry associated with this key if present.
+     *
+     * @param key A key identifying the requested entry.
+     * @return true if the key was found.
+     */
+    <T> T getValue(String key, T defaultEntry, Class<?>[] clazzs);
+
+    /**
+     * Gets cache file path;.
+     *
+     * @param key The cache file key.
+     * @return Cache file path.
+     */
+    String getCacheFilePath(String key);
+
+    boolean contains(String key);
+}

src/main/java/com/groupdocs/ui/cache/mixin/PageMixIn.java

@@ -0,0 +1,12 @@
+package com.groupdocs.ui.cache.mixin;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.groupdocs.viewer.results.Line;
+
+import java.util.List;
+
+public abstract class PageMixIn {
+    PageMixIn(@JsonProperty("number") int number, @JsonProperty("visible") boolean visible, @JsonProperty("width") int width, @JsonProperty("height") int height, @JsonProperty("lines") List<Line> lines) {
+    }
+
+}

src/main/java/com/groupdocs/ui/cache/mixin/PdfViewInfoMixIn.java

@@ -0,0 +1,13 @@
+package com.groupdocs.ui.cache.mixin;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.groupdocs.viewer.FileType;
+import com.groupdocs.viewer.results.Page;
+
+import java.util.List;
+
+public abstract class PdfViewInfoMixIn {
+    PdfViewInfoMixIn(@JsonProperty("fileType") FileType fileType, @JsonProperty("pages") List<Page> pages, @JsonProperty("printingAllowed") boolean printingAllowed) {
+    }
+
+}

src/main/java/com/groupdocs/ui/cache/mixin/ViewInfoMixIn.java

@@ -0,0 +1,13 @@
+package com.groupdocs.ui.cache.mixin;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.groupdocs.viewer.FileType;
+import com.groupdocs.viewer.results.Page;
+
+import java.util.List;
+
+public abstract class ViewInfoMixIn {
+    ViewInfoMixIn(@JsonProperty("fileType") FileType fileType, @JsonProperty("pages") List<Page> pages) {
+    }
+
+}