dorkbox/Utilities
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

CacheUtil can now be specified with a name (so more than 1 can exist). Better multi-threaded support for hashing

Browse Source
This commit is contained in:
Robinson 2021-01-31 00:37:20 +01:00
parent 6a368ccd13
commit 675515c35b
1 changed files with 38 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
src/dorkbox/util/CacheUtil.java
View File

@ -32,28 +32,32 @@ import dorkbox.os.OS;
public public
class CacheUtil { class CacheUtil {
// will never be null. private static final ThreadLocal<MessageDigest> digestLocal = new ThreadLocal<MessageDigest>() {
private static final MessageDigest digest; @Override
protected
static { MessageDigest initialValue() {
@SuppressWarnings("UnusedAssignment")
MessageDigest digest_ = null;
try { try {
digest_ = MessageDigest.getInstance("SHA1"); return MessageDigest.getInstance("SHA1");
} catch (NoSuchAlgorithmException e) { } catch (NoSuchAlgorithmException e) {
throw new RuntimeException("Unable to initialize hash algorithm for images. MD5 digest doesn't exist."); throw new RuntimeException("Unable to initialize hash algorithm. SHA1 digest doesn't exist?!? (This should not happen");
}
}
};
private final String tempDir;
public CacheUtil() {
this("cache");
} }
digest = digest_; public CacheUtil(String tempDir) {
this.tempDir = tempDir;
} }
public static String tempDir = "";
/** /**
* Clears ALL saved files in the cache * Clears ALL saved files in the cache
*/ */
public static synchronized public
void clear() { void clear() {
// deletes all of the files (recursively) in the specified location. If the directory is empty (no locked files), then the // deletes all of the files (recursively) in the specified location. If the directory is empty (no locked files), then the
// directory is also deleted. // directory is also deleted.
@ -66,7 +70,7 @@ class CacheUtil {
* <p> * <p>
* This cache is not persisted across runs. * This cache is not persisted across runs.
*/ */
public static synchronized public
File check(final File file) { File check(final File file) {
if (file == null) { if (file == null) {
throw new NullPointerException("file"); throw new NullPointerException("file");
@ -79,7 +83,7 @@ class CacheUtil {
/** /**
* Checks to see if the specified file is in the cache. NULL if it is not, otherwise specifies a location on disk. * Checks to see if the specified file is in the cache. NULL if it is not, otherwise specifies a location on disk.
*/ */
public static synchronized public
File check(final String fileName) { File check(final String fileName) {
if (fileName == null) { if (fileName == null) {
throw new NullPointerException("fileName"); throw new NullPointerException("fileName");
@ -99,7 +103,7 @@ class CacheUtil {
/** /**
* Checks to see if the specified URL is in the cache. NULL if it is not, otherwise specifies a location on disk. * Checks to see if the specified URL is in the cache. NULL if it is not, otherwise specifies a location on disk.
*/ */
public static synchronized public
File check(final URL fileResource) { File check(final URL fileResource) {
if (fileResource == null) { if (fileResource == null) {
throw new NullPointerException("fileResource"); throw new NullPointerException("fileResource");
@ -112,7 +116,7 @@ class CacheUtil {
* Checks to see if the specified stream (based on the hash of the input stream) is in the cache. NULL if it is not, otherwise * Checks to see if the specified stream (based on the hash of the input stream) is in the cache. NULL if it is not, otherwise
* specifies a location on disk. * specifies a location on disk.
*/ */
public static synchronized public
File check(final InputStream fileStream) throws IOException { File check(final InputStream fileStream) throws IOException {
if (fileStream == null) { if (fileStream == null) {
throw new NullPointerException("fileStream"); throw new NullPointerException("fileStream");
@ -125,7 +129,7 @@ class CacheUtil {
* Checks to see if the specified name is in the cache. NULL if it is not, otherwise specifies a location on disk. If the * Checks to see if the specified name is in the cache. NULL if it is not, otherwise specifies a location on disk. If the
* cacheName is NULL, it will use a HASH of the fileStream * cacheName is NULL, it will use a HASH of the fileStream
*/ */
public static synchronized public
File check(String cacheName, final InputStream fileStream) throws IOException { File check(String cacheName, final InputStream fileStream) throws IOException {
if (fileStream == null) { if (fileStream == null) {
throw new NullPointerException("fileStream"); throw new NullPointerException("fileStream");
@ -161,7 +165,7 @@ class CacheUtil {
/** /**
* Saves the name of the file in a cache, based on the file's name. * Saves the name of the file in a cache, based on the file's name.
*/ */
public static synchronized public
File save(final File file) throws IOException { File save(final File file) throws IOException {
return save(file.getAbsolutePath(), file); return save(file.getAbsolutePath(), file);
} }
@ -169,7 +173,7 @@ class CacheUtil {
/** /**
* Saves the name of the file in a cache, based on the specified name. If cacheName is NULL, it will use the file's name. * Saves the name of the file in a cache, based on the specified name. If cacheName is NULL, it will use the file's name.
*/ */
public static synchronized public
File save(String cacheName, final File file) throws IOException { File save(String cacheName, final File file) throws IOException {
if (cacheName == null) { if (cacheName == null) {
cacheName = file.getAbsolutePath(); cacheName = file.getAbsolutePath();
@ -180,7 +184,7 @@ class CacheUtil {
/** /**
* Saves the name of the file in a cache, based on the specified name. * Saves the name of the file in a cache, based on the specified name.
*/ */
public static synchronized public
File save(final String fileName) throws IOException { File save(final String fileName) throws IOException {
return save(null, fileName); return save(null, fileName);
} }
@ -190,7 +194,7 @@ class CacheUtil {
* *
* @return the newly create cache file, or an IOException if there were problems * @return the newly create cache file, or an IOException if there were problems
*/ */
public static synchronized public
File save(String cacheName, final String fileName) throws IOException { File save(String cacheName, final String fileName) throws IOException {
if (cacheName == null) { if (cacheName == null) {
cacheName = fileName; cacheName = fileName;
@ -235,7 +239,7 @@ class CacheUtil {
/** /**
* Saves the name of the URL in a cache, based on it's path. * Saves the name of the URL in a cache, based on it's path.
*/ */
public static synchronized public
File save(final URL fileResource) throws IOException { File save(final URL fileResource) throws IOException {
return save(null, fileResource); return save(null, fileResource);
} }
@ -243,7 +247,7 @@ class CacheUtil {
/** /**
* Saves the name of the URL in a cache, based on the specified name. If cacheName is NULL, it will use the URL's path. * Saves the name of the URL in a cache, based on the specified name. If cacheName is NULL, it will use the URL's path.
*/ */
public static synchronized public
File save(String cacheName, final URL fileResource) throws IOException { File save(String cacheName, final URL fileResource) throws IOException {
if (cacheName == null) { if (cacheName == null) {
cacheName = fileResource.getPath(); cacheName = fileResource.getPath();
@ -266,7 +270,7 @@ class CacheUtil {
/** /**
* This caches the data based on the HASH of the input stream. * This caches the data based on the HASH of the input stream.
*/ */
public static synchronized public
File save(final InputStream fileStream) throws IOException { File save(final InputStream fileStream) throws IOException {
if (fileStream == null) { if (fileStream == null) {
throw new NullPointerException("fileStream"); throw new NullPointerException("fileStream");
@ -279,7 +283,7 @@ class CacheUtil {
* Saves the name of the file in a cache, based on the cacheName. If the cacheName is NULL, it will use a HASH of the fileStream * Saves the name of the file in a cache, based on the cacheName. If the cacheName is NULL, it will use a HASH of the fileStream
* as the name. * as the name.
*/ */
public static synchronized public
File save(String cacheName, final InputStream fileStream) throws IOException { File save(String cacheName, final InputStream fileStream) throws IOException {
if (cacheName == null) { if (cacheName == null) {
cacheName = createNameAsHash(fileStream); cacheName = createNameAsHash(fileStream);
@ -316,7 +320,7 @@ class CacheUtil {
* @return the full path of the resource copied to disk, or NULL if invalid * @return the full path of the resource copied to disk, or NULL if invalid
*/ */
@SuppressWarnings("ResultOfMethodCallIgnored") @SuppressWarnings("ResultOfMethodCallIgnored")
private static private
File makeFileViaStream(final String cacheName, final InputStream resourceStream) throws IOException { File makeFileViaStream(final String cacheName, final InputStream resourceStream) throws IOException {
if (resourceStream == null) { if (resourceStream == null) {
throw new NullPointerException("resourceStream"); throw new NullPointerException("resourceStream");
@ -368,7 +372,7 @@ class CacheUtil {
* *
* @return the file on disk represented by the file name * @return the file on disk represented by the file name
*/ */
public static synchronized public
File create(final String cacheName) { File create(final String cacheName) {
return makeCacheFile(cacheName); return makeCacheFile(cacheName);
} }
@ -376,7 +380,7 @@ class CacheUtil {
// creates the file that will be cached. It may, or may not already exist // creates the file that will be cached. It may, or may not already exist
// must be called from synchronized block! // must be called from synchronized block!
// never returns null // never returns null
private static private
File makeCacheFile(final String cacheName) { File makeCacheFile(final String cacheName) {
if (cacheName == null) { if (cacheName == null) {
throw new NullPointerException("cacheName"); throw new NullPointerException("cacheName");
@ -399,12 +403,12 @@ class CacheUtil {
return newFile; return newFile;
} }
// must be called from synchronized block!
// hashed name to prevent invalid file names from being used // hashed name to prevent invalid file names from being used
private static private static
String hashName(final String name) { String hashName(final String name) {
// figure out the fileName // figure out the fileName
byte[] bytes = name.getBytes(OS.UTF_8); byte[] bytes = name.getBytes(OS.UTF_8);
MessageDigest digest = digestLocal.get();
digest.reset(); digest.reset();
digest.update(bytes); digest.update(bytes);
@ -414,8 +418,10 @@ class CacheUtil {
} }
// this is if we DO NOT have a file name. We hash the resourceStream bytes to base the name on that. The extension will be ".cache" // this is if we DO NOT have a file name. We hash the resourceStream bytes to base the name on that. The extension will be ".cache"
public static synchronized public static
String createNameAsHash(final InputStream resourceStream) throws IOException { String createNameAsHash(final InputStream resourceStream) throws IOException {
MessageDigest digest = digestLocal.get();
digest.reset(); digest.reset();
try { try {