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.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;
  42 import java.util.Map;
  43 import java.util.Map.Entry;
  44 import java.util.NavigableMap;
  45 import java.util.Set;
  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;
  52
  53 import javax.servlet.http.HttpServletRequest;
  54 import javax.servlet.http.HttpServletResponse;
  55
  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;
  62 /*
  63  * CachingFileAccess
  64  *
  65  * Author: Jonathan Gathman, Gathsys 2010
  66  *
  67  */
  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]));
  77                         }
  78                 }
  79         }
  80
  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";
  95
  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
 101         private Timer timer;
 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;
 108
 109         public CachingFileAccess(EnvJAXB env, String ... args) throws IOException {
 110                 super(null,"Caching File Access");
 111                 setEnv(env,args);
 112                 content = new ConcurrentSkipListMap<String,Content>(); // multi-thread changes possible
 113
 114                 attachOnly = new HashSet<String>();     // short, unchanged
 115
 116                 typeMap = new TreeMap<String,String>(); // 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");
 127
 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");
 139
 140                 timer = new Timer("Caching Cleanup",true);
 141                 timer.schedule(new Cleanup(content,500),60000,60000);
 142
 143                 // Property params
 144                 web_path = env.get(env.staticSlot(CFA_WEB_PATH));
 145                 env.init().log("CachingFileAccess path: " + new File(web_path).getCanonicalPath());
 146                 Object obj;
 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);}
 150
 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);}
 154
 155                 clear_command = env.getProperty(CFA_CLEAR_COMMAND,null);
 156         }
 157
 158
 159
 160         @Override
 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)) {
 167                                 content.clear();
 168                                 resp.setStatus(200/*HttpStatus.OK_200*/);
 169                         } else {
 170                                 resp.setStatus(400/*HttpStatus.BAD_REQUEST_400 */);
 171                         }
 172                         return;
 173                 }
 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");
 177                 }
 178                 c.setHeader(resp);
 179                 c.write(resp.getOutputStream());
 180                 trans.checkpoint(req.getPathInfo());
 181         }
 182
 183
 184         public String webPath() {
 185                 return web_path;
 186         }
 187
 188         /**
 189          * Reset the Cleanup size and interval
 190          *
 191          * The size and interval when started are 500 items (memory size unknown) checked every minute in a background thread.
 192          *
 193          * @param size
 194          * @param interval
 195          */
 196         public void cleanupParams(int size, long interval) {
 197                 timer.cancel();
 198                 timer = new Timer();
 199                 timer.schedule(new Cleanup(content,size), interval, interval);
 200         }
 201
 202
 203
 204         /**
 205          * Load a file, first checking cache
 206          *
 207          *
 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
 213          * @return
 214          * @throws IOException
 215          */
 216         public Content load(LogTarget logTarget, String dataRoot, String key, String mediaType, long _timeCheck) throws IOException {
 217             long timeCheck = _timeCheck;
 218                 if(timeCheck<0) {
 219                         timeCheck=checkInterval; // if time < 0, then use default
 220                 }
 221                 boolean isRoot;
 222                 String fileName;
 223                 if("-".equals(key)) {
 224                         fileName = dataRoot;
 225                         isRoot = true;
 226                 } else {
 227                         fileName=dataRoot + '/' + key;
 228                         isRoot = false;
 229                 }
 230                 Content c = content.get(key);
 231                 long systime = System.currentTimeMillis();
 232                 File f=null;
 233                 if(c!=null) {
 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) {
 238                                         c=null;
 239                                 }
 240                         }
 241                 }
 242                 if(c==null) {
 243                         if(logTarget!=null) {
 244                                 logTarget.log("File Read: ",key);
 245                         }
 246
 247                         if(f==null){
 248                                 f = new File(fileName);
 249                         }
 250                         boolean cacheMe;
 251                         if(f.exists()) {
 252                                 if(f.isDirectory()) {
 253                                         cacheMe = false;
 254                                         c = new DirectoryContent(f,isRoot);
 255                                 } else {
 256                                         if(f.length() > maxItemSize) {
 257                                                 c = new DirectFileContent(f);
 258                                                 cacheMe = false;
 259                                         } else {
 260                                                 c = new CachedContent(f);
 261                                                 cacheMe = checkInterval>0;
 262                                         }
 263
 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";
 270                                                 }
 271                                                 c.attachmentOnly = attachOnly.contains(subkey);
 272                                         } else {
 273                                                 c.contentType=mediaType;
 274                                                 c.attachmentOnly = false;
 275                                         }
 276
 277                                         c.date = f.lastModified();
 278
 279                                         if(cacheMe) {
 280                                                 content.put(key, c);
 281                                         }
 282                                 }
 283                         } else {
 284                                 c=NULL;
 285                         }
 286                 } else {
 287                         if(logTarget!=null)logTarget.log("Cache Read: ",key);
 288                 }
 289
 290                 // refresh hit time
 291                 c.access = systime;
 292                 return c;
 293         }
 294
 295         public Content loadOrDefault(Trans trans, String targetDir, String targetFileName, String sourcePath, String mediaType) throws IOException {
 296                 try {
 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);
 301                         try {
 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);
 307                                 try {
 308                                         ByteBuffer bb = ByteBuffer.allocate((int)sourceFC.size());
 309                                         sourceFC.read(bb);
 310                                         bb.flip();  // ready for reading
 311                                         targetFOS.getChannel().write(bb);
 312                                 } finally {
 313                                         sourceFIS.close();
 314                                         targetFOS.close();
 315                                 }
 316                         } finally {
 317                                 tt.done();
 318                         }
 319                         return load(trans.info(),targetDir,targetFileName,mediaType,0);
 320                 }
 321         }
 322
 323         public void invalidate(String key) {
 324                 content.remove(key);
 325         }
 326
 327         private static final Content NULL=new Content() {
 328
 329                 @Override
 330                 public void setHeader(HttpServletResponse resp) {
 331                         resp.setStatus(404/*NOT_FOUND_404*/);
 332                         resp.setHeader("Content-type","text/plain");
 333                 }
 334
 335                 @Override
 336                 public void write(Writer writer) throws IOException {
 337                 }
 338
 339                 @Override
 340                 public void write(OutputStream os) throws IOException {
 341                 }
 342
 343         };
 344
 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
 348
 349                 protected String  contentType;
 350                 protected boolean attachmentOnly;
 351
 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);
 356                 }
 357
 358                 public abstract void write(Writer writer) throws IOException;
 359                 public abstract void write(OutputStream os) throws IOException;
 360
 361         }
 362
 363         private static class DirectFileContent extends Content {
 364                 private File file;
 365                 public DirectFileContent(File f) {
 366                         file = f;
 367                 }
 368
 369                 public String toString() {
 370                         return file.getName();
 371                 }
 372
 373                 public void write(Writer writer) throws IOException {
 374                         FileReader fr = new FileReader(file);
 375                         char[] buff = new char[1024];
 376                         try {
 377                                 int read;
 378                                 while((read = fr.read(buff,0,1024))>=0) {
 379                                         writer.write(buff,0,read);
 380                                 }
 381                         } finally {
 382                                 fr.close();
 383                         }
 384                 }
 385
 386                 public void write(OutputStream os) throws IOException {
 387                         FileInputStream fis = new FileInputStream(file);
 388                         byte[] buff = new byte[1024];
 389                         try {
 390                                 int read;
 391                                 while((read = fis.read(buff,0,1024))>=0) {
 392                                         os.write(buff,0,read);
 393                                 }
 394                         } finally {
 395                                 fis.close();
 396                         }
 397                 }
 398
 399         }
 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;
 406                 private String name;
 407                 private boolean notRoot;
 408
 409                 public DirectoryContent(File directory, boolean isRoot) {
 410                         notRoot = !isRoot;
 411
 412                         files = directory.listFiles();
 413                         Arrays.sort(files,new Comparator<File>() {
 414                                 @Override
 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
 421                                                 int i1 = m1.start();
 422                                                 int i2 = m2.start();
 423
 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);
 428                                                 }
 429                                         }
 430                                         return f1.compareTo(f2);
 431                                 }
 432
 433                         });
 434                         name = directory.getName();
 435                         attachmentOnly = false;
 436                         contentType = "text/html";
 437                 }
 438
 439
 440                 @Override
 441                 public void write(Writer w) throws IOException {
 442                         w.append(H1);
 443                         w.append(name);
 444                         w.append(H2);
 445                         for (File f : files) {
 446                                 w.append("<li><a href=\"");
 447                                 if(notRoot) {
 448                                         w.append(name);
 449                                         w.append('/');
 450                                 }
 451                                 w.append(f.getName());
 452                                 w.append("\">");
 453                                 w.append(f.getName());
 454                                 w.append("</a></li>\n");
 455                         }
 456                         w.append(F);
 457                         w.flush();
 458                 }
 459
 460                 @Override
 461                 public void write(OutputStream os) throws IOException {
 462                         write(new OutputStreamWriter(os));
 463                 }
 464
 465         }
 466
 467         private static class CachedContent extends Content {
 468                 private byte[] data;
 469                 private int end;
 470                 private char[] cdata;
 471
 472                 public CachedContent(File f) throws IOException {
 473                         // Read and Cache
 474                         ByteBuffer bb = ByteBuffer.allocate((int)f.length());
 475                         FileInputStream fis = new FileInputStream(f);
 476                         try {
 477                                 fis.getChannel().read(bb);
 478                         } finally {
 479                                 fis.close();
 480                         }
 481
 482                         data = bb.array();
 483                         end = bb.position();
 484                         cdata=null;
 485                 }
 486
 487                 public String toString() {
 488                         return Arrays.toString(data);
 489                 }
 490
 491                 public void write(Writer writer) throws IOException {
 492                         synchronized(this) {
 493                                 // do the String Transformation once, and only if actually used
 494                                 if(cdata==null) {
 495                                         cdata = new char[end];
 496                                         new String(data).getChars(0, end, cdata, 0);
 497                                 }
 498                         }
 499                         writer.write(cdata,0,end);
 500                 }
 501                 public void write(OutputStream os) throws IOException {
 502                         os.write(data,0,end);
 503                 }
 504
 505         }
 506
 507         public void setEnv(LogTarget env) {
 508                 logT = env;
 509         }
 510
 511         /**
 512          * Cleanup thread to remove older items if max Cache is reached.
 513          * @author Jonathan
 514          *
 515          */
 516         private static class Cleanup extends TimerTask {
 517                 private int maxSize;
 518                 private NavigableMap<String, Content> content;
 519
 520                 public Cleanup(NavigableMap<String, Content> content, int size) {
 521                         maxSize = size;
 522                         this.content = content;
 523                 }
 524
 525                 private class Comp implements Comparable<Comp> {
 526                         public Map.Entry<String, Content> entry;
 527
 528                         public Comp(Map.Entry<String, Content> en) {
 529                                 entry = en;
 530                         }
 531
 532                         @Override
 533                         public int compareTo(Comp o) {
 534                                 return (int)(entry.getValue().access-o.entry.getValue().access);
 535                         }
 536
 537                 }
 538                 @SuppressWarnings("unchecked")
 539                 @Override
 540                 public void run() {
 541                         int size = content.size();
 542                         if(size>maxSize) {
 543                                 ArrayList<Comp> scont = new ArrayList<Comp>(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]));
 547                                 }
 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());
 555                                 }
 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());
 559                                 }
 560                         }
 561                 }
 562         }
 563 }