auth/auth-core/src/main/java/org/onap/aaf/auth/rserv/CachingFileAccess.java

   1 /**
   2  * ============LICENSE_START====================================================
   3  * org.onap.aaf
   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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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====================================================
  19  *
  20  */
  21
  22 package org.onap.aaf.auth.rserv;
  23
  24
  25 import java.io.File;
  26 import java.io.FileInputStream;
  27 import java.io.FileReader;
  28 import java.io.IOException;
  29 import java.io.OutputStream;
  30 import java.io.OutputStreamWriter;
  31 import java.io.Writer;
  32 import java.nio.ByteBuffer;
  33 import java.util.ArrayList;
  34 import java.util.Arrays;
  35 import java.util.Collections;
  36 import java.util.Comparator;
  37 import java.util.HashSet;
  38 import java.util.Map;
  39 import java.util.Map.Entry;
  40 import java.util.NavigableMap;
  41 import java.util.Set;
  42 import java.util.Timer;
  43 import java.util.TimerTask;
  44 import java.util.TreeMap;
  45 import java.util.concurrent.ConcurrentSkipListMap;
  46 import java.util.regex.Matcher;
  47 import java.util.regex.Pattern;
  48
  49 import javax.servlet.http.HttpServletRequest;
  50 import javax.servlet.http.HttpServletResponse;
  51
  52 import org.onap.aaf.misc.env.EnvJAXB;
  53 import org.onap.aaf.misc.env.LogTarget;
  54 import org.onap.aaf.misc.env.Store;
  55 import org.onap.aaf.misc.env.Trans;
  56 /*
  57  * CachingFileAccess
  58  *
  59  * Author: Jonathan Gathman, Gathsys 2010
  60  *
  61  */
  62 public class CachingFileAccess<TRANS extends Trans> extends HttpCode<TRANS, Void> {
  63     public static void setEnv(Store store, String[] args) {
  64         for (int i=0;i<args.length-1;i+=2) { // cover two parms required for each
  65             if (CFA_WEB_PATH.equals(args[i])) {
  66                 store.put(store.staticSlot(CFA_WEB_PATH), args[i+1]);
  67             } else if (CFA_CACHE_CHECK_INTERVAL.equals(args[i])) {
  68                 store.put(store.staticSlot(CFA_CACHE_CHECK_INTERVAL), Long.parseLong(args[i+1]));
  69             } else if (CFA_MAX_SIZE.equals(args[i])) {
  70                 store.put(store.staticSlot(CFA_MAX_SIZE), Integer.parseInt(args[i+1]));
  71             }
  72         }
  73     }
  74
  75     private static String MAX_AGE = "max-age=3600"; // 1 hour Caching
  76     private final Map<String,String> typeMap;
  77     private final NavigableMap<String,Content> content;
  78     private final Set<String> attachOnly;
  79     public final static String CFA_WEB_PATH = "aaf_cfa_web_path";
  80     // when to re-validate from file
  81     // Re validating means comparing the Timestamp on the disk, and seeing it has changed.  Cache is not marked
  82     // dirty unless file has changed, but it still makes File IO, which for some kinds of cached data, i.e.
  83     // deployed GUI elements is unnecessary, and wastes time.
  84     // This parameter exists to cover the cases where data can be more volatile, so the user can choose how often the
  85     // File IO will be accessed, based on probability of change.  "0", of course, means, check every time.
  86     private final static String CFA_CACHE_CHECK_INTERVAL = "aaf_cfa_cache_check_interval";
  87     private final static String CFA_MAX_SIZE = "aaf_cfa_max_size"; // Cache size limit
  88     private final static String CFA_CLEAR_COMMAND = "aaf_cfa_clear_command";
  89
  90     // Note: can be null without a problem, but included
  91     // to tie in with existing Logging.
  92     public LogTarget logT = null;
  93     public long checkInterval; // = 600000L; // only check if not hit in 10 mins by default
  94     public int maxItemSize; // = 512000; // max file 500k
  95     private Timer timer;
  96     private String web_path;
  97     // A command key is set in the Properties, preferably changed on deployment.
  98     // it is compared at the beginning of the path, and if so, it is assumed to issue certain commands
  99     // It's purpose is to protect, to some degree the command, even though it is HTTP, allowing
 100     // local batch files to, for instance, clear caches on resetting of files.
 101     private String clear_command;
 102
 103     public CachingFileAccess(EnvJAXB env, String ... args) throws IOException {
 104         super(null,"Caching File Access");
 105         setEnv(env,args);
 106         content = new ConcurrentSkipListMap<>(); // multi-thread changes possible
 107
 108         attachOnly = new HashSet<>();     // short, unchanged
 109
 110         typeMap = new TreeMap<>(); // Structure unchanged after Construction
 111         typeMap.put("ico","image/icon");
 112         typeMap.put("html","text/html");
 113         typeMap.put("css","text/css");
 114         typeMap.put("js","text/javascript");
 115         typeMap.put("txt","text/plain");
 116         typeMap.put("xml","text/xml");
 117         typeMap.put("xsd","text/xml");
 118         attachOnly.add("xsd");
 119         typeMap.put("crl", "application/x-pkcs7-crl");
 120         typeMap.put("appcache","text/cache-manifest");
 121
 122         typeMap.put("json","text/json");
 123         typeMap.put("ogg", "audio/ogg");
 124         typeMap.put("jpg","image/jpeg");
 125         typeMap.put("gif","image/gif");
 126         typeMap.put("png","image/png");
 127         typeMap.put("svg","image/svg+xml");
 128         typeMap.put("jar","application/x-java-applet");
 129         typeMap.put("jnlp", "application/x-java-jnlp-file");
 130         typeMap.put("class", "application/java");
 131         typeMap.put("props", "text/plain");
 132         typeMap.put("jks", "application/octet-stream");
 133
 134         timer = new Timer("Caching Cleanup",true);
 135         timer.schedule(new Cleanup(content,500),60000,60000);
 136
 137         // Property params
 138         web_path = env.get(env.staticSlot(CFA_WEB_PATH));
 139         env.init().log("CachingFileAccess path: " + new File(web_path).getCanonicalPath());
 140         Object obj;
 141         obj = env.get(env.staticSlot(CFA_CACHE_CHECK_INTERVAL),600000L);  // Default is 10 mins
 142         if (obj instanceof Long) {checkInterval=(Long)obj;
 143         } else {checkInterval=Long.parseLong((String)obj);}
 144
 145         obj = env.get(env.staticSlot(CFA_MAX_SIZE), 512000);    // Default is max file 500k
 146         if (obj instanceof Integer) {maxItemSize=(Integer)obj;
 147         } else {maxItemSize =Integer.parseInt((String)obj);}
 148
 149          clear_command = env.getProperty(CFA_CLEAR_COMMAND,null);
 150     }
 151
 152
 153
 154     @Override
 155     public void handle(TRANS trans, HttpServletRequest req, HttpServletResponse resp) throws IOException {
 156         String key = pathParam(req, ":key");
 157         int slash = key.indexOf('/');
 158         if(key.length()>2 && slash>=0 && key.substring(0,slash).equals(clear_command)) {
 159             resp.setHeader("Content-Type",typeMap.get("txt"));
 160             if ("clear".equals(key.substring(slash+1))) {
 161                 content.clear();
 162                 resp.setStatus(200/*HttpStatus.OK_200*/);
 163             } else {
 164                 resp.setStatus(400/*HttpStatus.BAD_REQUEST_400 */);
 165             }
 166             return;
 167         }
 168         Content c = load(logT , web_path,key, null, checkInterval);
 169         if (c.attachmentOnly) {
 170             resp.setHeader("Content-disposition", "attachment");
 171         }
 172         c.setHeader(resp);
 173         c.write(resp.getOutputStream());
 174         trans.checkpoint(req.getPathInfo());
 175     }
 176
 177
 178     public String webPath() {
 179         return web_path;
 180     }
 181
 182     /**
 183      * Reset the Cleanup size and interval
 184      *
 185      * The size and interval when started are 500 items (memory size unknown) checked every minute in a background thread.
 186      *
 187      * @param size
 188      * @param interval
 189      */
 190     public void cleanupParams(int size, long interval) {
 191         timer.cancel();
 192         timer = new Timer();
 193         timer.schedule(new Cleanup(content,size), interval, interval);
 194     }
 195
 196
 197
 198     /**
 199      * Load a file, first checking cache
 200      *
 201      *
 202      * @param logTarget - logTarget can be null (won't log)
 203      * @param dataRoot - data root storage directory
 204      * @param key - relative File Path
 205      * @param mediaType - what kind of file is it.  If null, will check via file extension
 206      * @param timeCheck - "-1" will take system default - Otherwise, will compare "now" + timeCheck(Millis) before looking at File mod
 207      * @return
 208      * @throws IOException
 209      */
 210     public Content load(LogTarget logTarget, String dataRoot, String key, String mediaType, long _timeCheck) throws IOException {
 211         long timeCheck = _timeCheck;
 212         if (timeCheck<0) {
 213             timeCheck=checkInterval; // if time < 0, then use default
 214         }
 215         boolean isRoot;
 216         String fileName;
 217         if ("-".equals(key)) {
 218             fileName = dataRoot;
 219             isRoot = true;
 220         } else {
 221             fileName=dataRoot + '/' + key;
 222             isRoot = false;
 223         }
 224         Content c = content.get(key);
 225         long systime = System.currentTimeMillis();
 226         File f=null;
 227         if (c!=null) {
 228             // Don't check every hit... only after certain time value
 229             if (c.date < systime + timeCheck) {
 230                 f = new File(fileName);
 231                 if (f.lastModified()>c.date) {
 232                     c=null;
 233                 }
 234             }
 235         }
 236         if (c==null) {
 237             if (logTarget!=null) {
 238                 logTarget.log("File Read: ",key);
 239             }
 240
 241             if (f==null){
 242                 f = new File(fileName);
 243             }
 244             boolean cacheMe;
 245             if (f.exists()) {
 246                 if (f.isDirectory()) {
 247                     cacheMe = false;
 248                     c = new DirectoryContent(f,isRoot);
 249                 } else {
 250                     if (f.length() > maxItemSize) {
 251                         c = new DirectFileContent(f);
 252                         cacheMe = false;
 253                     } else {
 254                         c = new CachedContent(f);
 255                         cacheMe = checkInterval>0;
 256                     }
 257
 258                     if (mediaType==null) { // determine from file Ending
 259                         int idx = key.lastIndexOf('.');
 260                         String subkey = key.substring(++idx);
 261                         if ((c.contentType = idx<0?null:typeMap.get(subkey))==null) {
 262                             // if nothing else, just set to default type...
 263                             c.contentType = "application/octet-stream";
 264                         }
 265                         c.attachmentOnly = attachOnly.contains(subkey);
 266                     } else {
 267                         c.contentType=mediaType;
 268                         c.attachmentOnly = false;
 269                     }
 270
 271                     c.date = f.lastModified();
 272
 273                     if (cacheMe) {
 274                         content.put(key, c);
 275                     }
 276                 }
 277             } else {
 278                 c=NULL;
 279             }
 280         } else {
 281             if (logTarget!=null)logTarget.log("Cache Read: ",key);
 282         }
 283
 284         // refresh hit time
 285         c.access = systime;
 286         return c;
 287     }
 288
 289
 290     public void invalidate(String key) {
 291         content.remove(key);
 292     }
 293
 294     private static final Content NULL=new Content() {
 295
 296         @Override
 297         public void setHeader(HttpServletResponse resp) {
 298             resp.setStatus(404/*NOT_FOUND_404*/);
 299             resp.setHeader("Content-type","text/plain");
 300         }
 301
 302         @Override
 303         public void write(Writer writer) throws IOException {
 304         }
 305
 306         @Override
 307         public void write(OutputStream os) throws IOException {
 308         }
 309
 310     };
 311
 312     private static abstract class Content {
 313         private long date;   // date of the actual artifact (i.e. File modified date)
 314         private long access; // last accessed
 315
 316         protected String  contentType;
 317         protected boolean attachmentOnly;
 318
 319         public void setHeader(HttpServletResponse resp) {
 320             resp.setStatus(200/*OK_200*/);
 321             resp.setHeader("Content-Type",contentType);
 322             resp.setHeader("Cache-Control", MAX_AGE);
 323         }
 324
 325         public abstract void write(Writer writer) throws IOException;
 326         public abstract void write(OutputStream os) throws IOException;
 327
 328     }
 329
 330     private static class DirectFileContent extends Content {
 331         private File file;
 332         public DirectFileContent(File f) {
 333             file = f;
 334         }
 335
 336         public String toString() {
 337             return file.getName();
 338         }
 339
 340         public void write(Writer writer) throws IOException {
 341             FileReader fr = new FileReader(file);
 342             char[] buff = new char[1024];
 343             try {
 344                 int read;
 345                 while ((read = fr.read(buff,0,1024))>=0) {
 346                     writer.write(buff,0,read);
 347                 }
 348             } finally {
 349                 fr.close();
 350             }
 351         }
 352
 353         public void write(OutputStream os) throws IOException {
 354             FileInputStream fis = new FileInputStream(file);
 355             byte[] buff = new byte[1024];
 356             try {
 357                 int read;
 358                 while ((read = fis.read(buff,0,1024))>=0) {
 359                     os.write(buff,0,read);
 360                 }
 361             } finally {
 362                 fis.close();
 363             }
 364         }
 365
 366     }
 367     private static class DirectoryContent extends Content {
 368         private static final Pattern A_NUMBER = Pattern.compile("\\d");
 369         private static final String H1 = "<html><head><title>AAF Fileserver</title></head><body><h1>AAF Fileserver</h1><h2>";
 370         private static final String H2 = "</h2><ul>\n";
 371         private static final String F = "\n</ul></body></html>";
 372         private File[] files;
 373         private String name;
 374         private boolean notRoot;
 375
 376         public DirectoryContent(File directory, boolean isRoot) {
 377             notRoot = !isRoot;
 378
 379             files = directory.listFiles();
 380             Arrays.sort(files,new Comparator<File>() {
 381                 @Override
 382                 public int compare(File f1, File f2) {
 383                     // See if there are Numbers in the name
 384                     Matcher m1 = A_NUMBER.matcher(f1.getName());
 385                     Matcher m2 = A_NUMBER.matcher(f2.getName());
 386                     if (m1.find() && m2.find()) {
 387                         // if numbers, are the numbers in the same start position
 388                         int i1 = m1.start();
 389                         int i2 = m2.start();
 390
 391                         // If same start position and the text is the same, then reverse sort
 392                         if (i1==i2 && f1.getName().startsWith(f2.getName().substring(0,i1))) {
 393                             // reverse sort files that start similarly, but have numbers in them
 394                             return f2.compareTo(f1);
 395                         }
 396                     }
 397                     return f1.compareTo(f2);
 398                 }
 399
 400             });
 401             name = directory.getName();
 402             attachmentOnly = false;
 403             contentType = "text/html";
 404         }
 405
 406
 407         @Override
 408         public void write(Writer w) throws IOException {
 409             w.append(H1);
 410             w.append(name);
 411             w.append(H2);
 412             for (File f : files) {
 413                 w.append("<li><a href=\"");
 414                 if (notRoot) {
 415                     w.append(name);
 416                     w.append('/');
 417                 }
 418                 w.append(f.getName());
 419                 w.append("\">");
 420                 w.append(f.getName());
 421                 w.append("</a></li>\n");
 422             }
 423             w.append(F);
 424             w.flush();
 425         }
 426
 427         @Override
 428         public void write(OutputStream os) throws IOException {
 429             write(new OutputStreamWriter(os));
 430         }
 431
 432     }
 433
 434     private static class CachedContent extends Content {
 435         private byte[] data;
 436         private int end;
 437         private char[] cdata;
 438
 439         public CachedContent(File f) throws IOException {
 440             // Read and Cache
 441             ByteBuffer bb = ByteBuffer.allocate((int)f.length());
 442             FileInputStream fis = new FileInputStream(f);
 443             try {
 444                 fis.getChannel().read(bb);
 445             } finally {
 446                 fis.close();
 447             }
 448
 449             data = bb.array();
 450             end = bb.position();
 451             cdata=null;
 452         }
 453
 454         public String toString() {
 455             return Arrays.toString(data);
 456         }
 457
 458         public void write(Writer writer) throws IOException {
 459             synchronized(this) {
 460                 // do the String Transformation once, and only if actually used
 461                 if (cdata==null) {
 462                     cdata = new char[end];
 463                     new String(data).getChars(0, end, cdata, 0);
 464                 }
 465             }
 466             writer.write(cdata,0,end);
 467         }
 468         public void write(OutputStream os) throws IOException {
 469             os.write(data,0,end);
 470         }
 471
 472     }
 473
 474     public void setEnv(LogTarget env) {
 475         logT = env;
 476     }
 477
 478     /**
 479      * Cleanup thread to remove older items if max Cache is reached.
 480      * @author Jonathan
 481      *
 482      */
 483     private static class Cleanup extends TimerTask {
 484         private int maxSize;
 485         private NavigableMap<String, Content> content;
 486
 487         public Cleanup(NavigableMap<String, Content> content, int size) {
 488             maxSize = size;
 489             this.content = content;
 490         }
 491
 492         private class Comp implements Comparable<Comp> {
 493             public Map.Entry<String, Content> entry;
 494
 495             public Comp(Map.Entry<String, Content> en) {
 496                 entry = en;
 497             }
 498
 499             @Override
 500             public int compareTo(Comp o) {
 501                 return (int)(entry.getValue().access-o.entry.getValue().access);
 502             }
 503
 504         }
 505         @SuppressWarnings("unchecked")
 506         @Override
 507         public void run() {
 508             int size = content.size();
 509             if (size>maxSize) {
 510                 ArrayList<Comp> scont = new ArrayList<>(size);
 511                 Object[] entries = content.entrySet().toArray();
 512                 for (int i=0;i<size;++i) {
 513                     scont.add(i, new Comp((Map.Entry<String,Content>)entries[i]));
 514                 }
 515                 Collections.sort(scont);
 516                 int end = size - ((maxSize/4)*3); // reduce to 3/4 of max size
 517                 //System.out.println("------ Cleanup Cycle ------ " + new Date().toString() + " -------");
 518                 for (int i=0;i<end;++i) {
 519                     Entry<String, Content> entry = scont.get(i).entry;
 520                     content.remove(entry.getKey());
 521                     //System.out.println("removed Cache Item " + entry.getKey() + "/" + new Date(entry.getValue().access).toString());
 522                 }
 523 //                for (int i=end;i<size;++i) {
 524 //                    Entry<String, Content> entry = scont.get(i).entry;
 525 //                    //System.out.println("remaining Cache Item " + entry.getKey() + "/" + new Date(entry.getValue().access).toString());
 526 //                }
 527             }
 528         }
 529     }
 530 }