2 * ============LICENSE_START====================================================
4 * ===========================================================================
5 * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
6 * ===========================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END====================================================
22 package org.onap.aaf.auth.rserv;
26 import java.io.FileInputStream;
27 import java.io.FileNotFoundException;
28 import java.io.FileOutputStream;
29 import java.io.FileReader;
30 import java.io.IOException;
31 import java.io.OutputStream;
32 import java.io.OutputStreamWriter;
33 import java.io.Writer;
34 import java.nio.ByteBuffer;
35 import java.nio.channels.FileChannel;
36 import java.util.ArrayList;
37 import java.util.Arrays;
38 import java.util.Collections;
39 import java.util.Comparator;
40 import java.util.Date;
41 import java.util.HashSet;
43 import java.util.Map.Entry;
44 import java.util.NavigableMap;
46 import java.util.Timer;
47 import java.util.TimerTask;
48 import java.util.TreeMap;
49 import java.util.concurrent.ConcurrentSkipListMap;
50 import java.util.regex.Matcher;
51 import java.util.regex.Pattern;
53 import javax.servlet.http.HttpServletRequest;
54 import javax.servlet.http.HttpServletResponse;
56 import org.onap.aaf.misc.env.Env;
57 import org.onap.aaf.misc.env.EnvJAXB;
58 import org.onap.aaf.misc.env.LogTarget;
59 import org.onap.aaf.misc.env.Store;
60 import org.onap.aaf.misc.env.TimeTaken;
61 import org.onap.aaf.misc.env.Trans;
65 * Author: Jonathan Gathman, Gathsys 2010
68 public class CachingFileAccess<TRANS extends Trans> extends HttpCode<TRANS, Void> {
69 public static void setEnv(Store store, String[] args) {
70 for(int i=0;i<args.length-1;i+=2) { // cover two parms required for each
71 if(CFA_WEB_PATH.equals(args[i])) {
72 store.put(store.staticSlot(CFA_WEB_PATH), args[i+1]);
73 } else if(CFA_CACHE_CHECK_INTERVAL.equals(args[i])) {
74 store.put(store.staticSlot(CFA_CACHE_CHECK_INTERVAL), Long.parseLong(args[i+1]));
75 } else if(CFA_MAX_SIZE.equals(args[i])) {
76 store.put(store.staticSlot(CFA_MAX_SIZE), Integer.parseInt(args[i+1]));
81 private static String MAX_AGE = "max-age=3600"; // 1 hour Caching
82 private final Map<String,String> typeMap;
83 private final NavigableMap<String,Content> content;
84 private final Set<String> attachOnly;
85 public final static String CFA_WEB_PATH = "aaf_cfa_web_path";
86 // when to re-validate from file
87 // Re validating means comparing the Timestamp on the disk, and seeing it has changed. Cache is not marked
88 // dirty unless file has changed, but it still makes File IO, which for some kinds of cached data, i.e.
89 // deployed GUI elements is unnecessary, and wastes time.
90 // This parameter exists to cover the cases where data can be more volatile, so the user can choose how often the
91 // File IO will be accessed, based on probability of change. "0", of course, means, check every time.
92 private final static String CFA_CACHE_CHECK_INTERVAL = "aaf_cfa_cache_check_interval";
93 private final static String CFA_MAX_SIZE = "aaf_cfa_max_size"; // Cache size limit
94 private final static String CFA_CLEAR_COMMAND = "aaf_cfa_clear_command";
96 // Note: can be null without a problem, but included
97 // to tie in with existing Logging.
98 public LogTarget logT = null;
99 public long checkInterval; // = 600000L; // only check if not hit in 10 mins by default
100 public int maxItemSize; // = 512000; // max file 500k
102 private String web_path;
103 // A command key is set in the Properties, preferably changed on deployment.
104 // it is compared at the beginning of the path, and if so, it is assumed to issue certain commands
105 // It's purpose is to protect, to some degree the command, even though it is HTTP, allowing
106 // local batch files to, for instance, clear caches on resetting of files.
107 private String clear_command;
109 public CachingFileAccess(EnvJAXB env, String ... args) throws IOException {
110 super(null,"Caching File Access");
112 content = new ConcurrentSkipListMap<>(); // multi-thread changes possible
114 attachOnly = new HashSet<>(); // short, unchanged
116 typeMap = new TreeMap<>(); // Structure unchanged after Construction
117 typeMap.put("ico","image/icon");
118 typeMap.put("html","text/html");
119 typeMap.put("css","text/css");
120 typeMap.put("js","text/javascript");
121 typeMap.put("txt","text/plain");
122 typeMap.put("xml","text/xml");
123 typeMap.put("xsd","text/xml");
124 attachOnly.add("xsd");
125 typeMap.put("crl", "application/x-pkcs7-crl");
126 typeMap.put("appcache","text/cache-manifest");
128 typeMap.put("json","text/json");
129 typeMap.put("ogg", "audio/ogg");
130 typeMap.put("jpg","image/jpeg");
131 typeMap.put("gif","image/gif");
132 typeMap.put("png","image/png");
133 typeMap.put("svg","image/svg+xml");
134 typeMap.put("jar","application/x-java-applet");
135 typeMap.put("jnlp", "application/x-java-jnlp-file");
136 typeMap.put("class", "application/java");
137 typeMap.put("props", "text/plain");
138 typeMap.put("jks", "application/octet-stream");
140 timer = new Timer("Caching Cleanup",true);
141 timer.schedule(new Cleanup(content,500),60000,60000);
144 web_path = env.get(env.staticSlot(CFA_WEB_PATH));
145 env.init().log("CachingFileAccess path: " + new File(web_path).getCanonicalPath());
147 obj = env.get(env.staticSlot(CFA_CACHE_CHECK_INTERVAL),600000L); // Default is 10 mins
148 if(obj instanceof Long) {checkInterval=(Long)obj;
149 } else {checkInterval=Long.parseLong((String)obj);}
151 obj = env.get(env.staticSlot(CFA_MAX_SIZE), 512000); // Default is max file 500k
152 if(obj instanceof Integer) {maxItemSize=(Integer)obj;
153 } else {maxItemSize =Integer.parseInt((String)obj);}
155 clear_command = env.getProperty(CFA_CLEAR_COMMAND,null);
161 public void handle(TRANS trans, HttpServletRequest req, HttpServletResponse resp) throws IOException {
162 String key = pathParam(req, ":key");
163 String cmd = pathParam(req,":cmd");
164 if(key.equals(clear_command)) {
165 resp.setHeader("Content-Type",typeMap.get("txt"));
166 if("clear".equals(cmd)) {
168 resp.setStatus(200/*HttpStatus.OK_200*/);
170 resp.setStatus(400/*HttpStatus.BAD_REQUEST_400 */);
174 Content c = load(logT , web_path,cmd!=null && cmd.length()>0?key+'/'+cmd:key, null, checkInterval);
175 if(c.attachmentOnly) {
176 resp.setHeader("Content-disposition", "attachment");
179 c.write(resp.getOutputStream());
180 trans.checkpoint(req.getPathInfo());
184 public String webPath() {
189 * Reset the Cleanup size and interval
191 * The size and interval when started are 500 items (memory size unknown) checked every minute in a background thread.
196 public void cleanupParams(int size, long interval) {
199 timer.schedule(new Cleanup(content,size), interval, interval);
205 * Load a file, first checking cache
208 * @param logTarget - logTarget can be null (won't log)
209 * @param dataRoot - data root storage directory
210 * @param key - relative File Path
211 * @param mediaType - what kind of file is it. If null, will check via file extension
212 * @param timeCheck - "-1" will take system default - Otherwise, will compare "now" + timeCheck(Millis) before looking at File mod
214 * @throws IOException
216 public Content load(LogTarget logTarget, String dataRoot, String key, String mediaType, long _timeCheck) throws IOException {
217 long timeCheck = _timeCheck;
219 timeCheck=checkInterval; // if time < 0, then use default
223 if("-".equals(key)) {
227 fileName=dataRoot + '/' + key;
230 Content c = content.get(key);
231 long systime = System.currentTimeMillis();
234 // Don't check every hit... only after certain time value
235 if(c.date < systime + timeCheck) {
236 f = new File(fileName);
237 if(f.lastModified()>c.date) {
243 if(logTarget!=null) {
244 logTarget.log("File Read: ",key);
248 f = new File(fileName);
252 if(f.isDirectory()) {
254 c = new DirectoryContent(f,isRoot);
256 if(f.length() > maxItemSize) {
257 c = new DirectFileContent(f);
260 c = new CachedContent(f);
261 cacheMe = checkInterval>0;
264 if(mediaType==null) { // determine from file Ending
265 int idx = key.lastIndexOf('.');
266 String subkey = key.substring(++idx);
267 if((c.contentType = idx<0?null:typeMap.get(subkey))==null) {
268 // if nothing else, just set to default type...
269 c.contentType = "application/octet-stream";
271 c.attachmentOnly = attachOnly.contains(subkey);
273 c.contentType=mediaType;
274 c.attachmentOnly = false;
277 c.date = f.lastModified();
287 if(logTarget!=null)logTarget.log("Cache Read: ",key);
295 public Content loadOrDefault(Trans trans, String targetDir, String targetFileName, String sourcePath, String mediaType) throws IOException {
297 return load(trans.info(),targetDir,targetFileName,mediaType,0);
298 } catch(FileNotFoundException e) {
299 String targetPath = targetDir + '/' + targetFileName;
300 TimeTaken tt = trans.start("File doesn't exist; copy " + sourcePath + " to " + targetPath, Env.SUB);
302 FileInputStream sourceFIS = new FileInputStream(sourcePath);
303 FileChannel sourceFC = sourceFIS.getChannel();
304 File targetFile = new File(targetPath);
305 targetFile.getParentFile().mkdirs(); // ensure directory exists
306 FileOutputStream targetFOS = new FileOutputStream(targetFile);
308 ByteBuffer bb = ByteBuffer.allocate((int)sourceFC.size());
310 bb.flip(); // ready for reading
311 targetFOS.getChannel().write(bb);
319 return load(trans.info(),targetDir,targetFileName,mediaType,0);
323 public void invalidate(String key) {
327 private static final Content NULL=new Content() {
330 public void setHeader(HttpServletResponse resp) {
331 resp.setStatus(404/*NOT_FOUND_404*/);
332 resp.setHeader("Content-type","text/plain");
336 public void write(Writer writer) throws IOException {
340 public void write(OutputStream os) throws IOException {
345 private static abstract class Content {
346 private long date; // date of the actual artifact (i.e. File modified date)
347 private long access; // last accessed
349 protected String contentType;
350 protected boolean attachmentOnly;
352 public void setHeader(HttpServletResponse resp) {
353 resp.setStatus(200/*OK_200*/);
354 resp.setHeader("Content-Type",contentType);
355 resp.setHeader("Cache-Control", MAX_AGE);
358 public abstract void write(Writer writer) throws IOException;
359 public abstract void write(OutputStream os) throws IOException;
363 private static class DirectFileContent extends Content {
365 public DirectFileContent(File f) {
369 public String toString() {
370 return file.getName();
373 public void write(Writer writer) throws IOException {
374 FileReader fr = new FileReader(file);
375 char[] buff = new char[1024];
378 while((read = fr.read(buff,0,1024))>=0) {
379 writer.write(buff,0,read);
386 public void write(OutputStream os) throws IOException {
387 FileInputStream fis = new FileInputStream(file);
388 byte[] buff = new byte[1024];
391 while((read = fis.read(buff,0,1024))>=0) {
392 os.write(buff,0,read);
400 private static class DirectoryContent extends Content {
401 private static final Pattern A_NUMBER = Pattern.compile("\\d");
402 private static final String H1 = "<html><head><title>AAF Fileserver</title></head><body><h1>AAF Fileserver</h1><h2>";
403 private static final String H2 = "</h2><ul>\n";
404 private static final String F = "\n</ul></body></html>";
405 private File[] files;
407 private boolean notRoot;
409 public DirectoryContent(File directory, boolean isRoot) {
412 files = directory.listFiles();
413 Arrays.sort(files,new Comparator<File>() {
415 public int compare(File f1, File f2) {
416 // See if there are Numbers in the name
417 Matcher m1 = A_NUMBER.matcher(f1.getName());
418 Matcher m2 = A_NUMBER.matcher(f2.getName());
419 if(m1.find() && m2.find()) {
420 // if numbers, are the numbers in the same start position
424 // If same start position and the text is the same, then reverse sort
425 if(i1==i2 && f1.getName().startsWith(f2.getName().substring(0,i1))) {
426 // reverse sort files that start similarly, but have numbers in them
427 return f2.compareTo(f1);
430 return f1.compareTo(f2);
434 name = directory.getName();
435 attachmentOnly = false;
436 contentType = "text/html";
441 public void write(Writer w) throws IOException {
445 for (File f : files) {
446 w.append("<li><a href=\"");
451 w.append(f.getName());
453 w.append(f.getName());
454 w.append("</a></li>\n");
461 public void write(OutputStream os) throws IOException {
462 write(new OutputStreamWriter(os));
467 private static class CachedContent extends Content {
470 private char[] cdata;
472 public CachedContent(File f) throws IOException {
474 ByteBuffer bb = ByteBuffer.allocate((int)f.length());
475 FileInputStream fis = new FileInputStream(f);
477 fis.getChannel().read(bb);
487 public String toString() {
488 return Arrays.toString(data);
491 public void write(Writer writer) throws IOException {
493 // do the String Transformation once, and only if actually used
495 cdata = new char[end];
496 new String(data).getChars(0, end, cdata, 0);
499 writer.write(cdata,0,end);
501 public void write(OutputStream os) throws IOException {
502 os.write(data,0,end);
507 public void setEnv(LogTarget env) {
512 * Cleanup thread to remove older items if max Cache is reached.
516 private static class Cleanup extends TimerTask {
518 private NavigableMap<String, Content> content;
520 public Cleanup(NavigableMap<String, Content> content, int size) {
522 this.content = content;
525 private class Comp implements Comparable<Comp> {
526 public Map.Entry<String, Content> entry;
528 public Comp(Map.Entry<String, Content> en) {
533 public int compareTo(Comp o) {
534 return (int)(entry.getValue().access-o.entry.getValue().access);
538 @SuppressWarnings("unchecked")
541 int size = content.size();
543 ArrayList<Comp> scont = new ArrayList<>(size);
544 Object[] entries = content.entrySet().toArray();
545 for(int i=0;i<size;++i) {
546 scont.add(i, new Comp((Map.Entry<String,Content>)entries[i]));
548 Collections.sort(scont);
549 int end = size - ((maxSize/4)*3); // reduce to 3/4 of max size
550 //System.out.println("------ Cleanup Cycle ------ " + new Date().toString() + " -------");
551 for(int i=0;i<end;++i) {
552 Entry<String, Content> entry = scont.get(i).entry;
553 content.remove(entry.getKey());
554 //System.out.println("removed Cache Item " + entry.getKey() + "/" + new Date(entry.getValue().access).toString());
556 for(int i=end;i<size;++i) {
557 Entry<String, Content> entry = scont.get(i).entry;
558 //System.out.println("remaining Cache Item " + entry.getKey() + "/" + new Date(entry.getValue().access).toString());