summaryrefslogtreecommitdiffstats
path: root/ecomp-portal-widget-ms/widget-ms/src/main/java/org/onap/portalapp/widget/utils/UnzipUtil.java
blob: f20ed1b55b23b11850f464b97346df94ab4ce3dd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
package org.onap.portalapp.widget.utils;

import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.HashMap;
import java.util.Map;
import java.util.Stack;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;

import org.onap.portalapp.widget.constant.WidgetConstant;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class UnzipUtil {

	/**
	 * Size of the buffer to read/write data
	 */
	private static final int BUFFER_SIZE = 4096;
	private static final Logger logger = LoggerFactory.getLogger(UnzipUtil.class);

	/**
	 * Extracts a zip file specified by the zipFilePath to a directory specified by
	 * destDirectory (will be created if does not exists)
	 * 
	 * @param zipFilePath
	 *            path
	 * @param destDirectory
	 *            directory
	 * @param widgetName
	 *            name
	 * @return Map of contents
	 * @throws IOException
	 *             On error
	 */
	public Map<String, byte[]> unzip_db(String zipFilePath, String destDirectory, String widgetName)
			throws IOException {

		logger.debug("UnzipUtil.unzip_db: unzip widget file {}", widgetName);
		File destDir = new File(destDirectory);
		if (!destDir.exists())
			destDir.mkdir();
		try(ZipInputStream zipIn = new ZipInputStream(new FileInputStream(zipFilePath)))
		{
			ZipEntry entry = zipIn.getNextEntry();
			Map<String, byte[]> map = new HashMap<>();
	
			String[] requiredKeys = { WidgetConstant.WIDGET_CONTROLLER_LOCATION, WidgetConstant.WIDGET_MARKUP_LOCATION,
					WidgetConstant.WIDGET_STYLE_LOCATION };
			for (String k : requiredKeys)
				map.put(k, null);
	
			// iterates over entries in the zip file
			Stack<File> stack = new Stack<>();
			while (entry != null) {
				String filePath = destDirectory + File.separator + widgetName + File.separator
						+ entry.getName().substring(entry.getName().indexOf("/") + 1);
				final String entryShortName = entry.getName().substring(entry.getName().indexOf("/") + 1);
				logger.debug("UnzipUtil.unzip_db: file path {}, short name {}", filePath, entryShortName);
				if (!entry.isDirectory()) {
					// if the entry is a file, extracts it
					logger.debug("UnzipUtil.unzip_db: unzip and save widget file {}", filePath);
					stack.push(new File(filePath));
					extractFile(zipIn, filePath);
				} else {
					// if the entry is a directory, make the directory
					logger.debug("UnzipUtil.unzip_db: unzip and create widget folder {}", filePath);
					File dir = new File(filePath);
					stack.push(new File(filePath));
					dir.mkdir();
				}
				// Is this one we need?
				if (map.containsKey(entryShortName))
					map.put(entryShortName, Files.readAllBytes(Paths.get(filePath)));
				zipIn.closeEntry();
				entry = zipIn.getNextEntry();
			}
		
			while (!stack.isEmpty())
				stack.pop().delete();
	
			for (String k : requiredKeys)
				if (!map.containsKey(k))
					logger.warn("UnzipUtil.unzip_db: no zip archive entry found for required key {}", k);
			
			return map;
		}
	}

	/**
	 * Extracts a zip entry (file entry)
	 * 
	 * @param zipIn
	 * @param filePath
	 * @throws IOException
	 */
	private void extractFile(ZipInputStream zipIn, String filePath) throws IOException {
		try(BufferedOutputStream bos = new BufferedOutputStream(new FileOutputStream(filePath))){
			byte[] bytesIn = new byte[BUFFER_SIZE];
			int read = 0;
			while ((read = zipIn.read(bytesIn)) != -1) {
				bos.write(bytesIn, 0, read);
			}
		}
	}
}