[TIMOB-25663] Android: HttpClient.cache. ImageView.cache #9719
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| package ti.modules.titanium.android.httpresponsecache; | ||
|
|
||
| import org.appcelerator.kroll.KrollModule; | ||
| import org.appcelerator.kroll.annotations.Kroll; | ||
| import org.appcelerator.kroll.common.Log; | ||
| import org.appcelerator.titanium.TiApplication; | ||
|
|
||
| import ti.modules.titanium.android.AndroidModule; | ||
| import android.app.Activity; | ||
| import android.app.Notification; | ||
| import android.net.http.HttpResponseCache; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
|
|
||
| @Kroll.module(parentModule = AndroidModule.class) | ||
| public class HttpResponseCacheModule extends KrollModule | ||
| { | ||
| private static final String TAG = "HttpResponseCache"; | ||
| private static final String CACHE_SIZE_KEY = "ti.android.cache.size.max"; | ||
| private static final int DEFAULT_CACHE_SIZE = 25 * 1024; // 25MB | ||
|
|
||
| private String httpCachePath; | ||
| private long httpCacheSize; | ||
| private File httpCacheDir; | ||
|
|
||
| public HttpResponseCacheModule() | ||
| { | ||
| super(); | ||
| httpCachePath = "http"; | ||
| httpCacheSize = | ||
| TiApplication.getInstance().getAppProperties().getInt(CACHE_SIZE_KEY, DEFAULT_CACHE_SIZE) * 1024; | ||
| } | ||
|
|
||
| @Kroll.method | ||
| public boolean install() throws IOException | ||
| { | ||
| HttpResponseCache cache = HttpResponseCache.getInstalled(); | ||
| if (cache != null) { | ||
| cache.flush(); | ||
| cache.close(); | ||
| } | ||
| TiApplication tiApp = TiApplication.getInstance(); | ||
| File dir = tiApp.getApplicationContext().getExternalCacheDir(); | ||
| if (dir == null) { | ||
| dir = tiApp.getApplicationContext().getCacheDir(); | ||
| } | ||
| httpCacheDir = new File(dir, httpCachePath); | ||
| if (!httpCacheDir.exists()) { | ||
| if (!httpCacheDir.mkdir()) { | ||
| Log.e(TAG, "Failed to create cache directory"); | ||
| return false; | ||
| } | ||
| } else if (!httpCacheDir.isDirectory()) { | ||
| Log.e(TAG, "Failed to create cache directory. \"" + httpCacheDir.getPath() + "\" exists."); | ||
| return false; | ||
| } | ||
| cache = HttpResponseCache.install(httpCacheDir, httpCacheSize); | ||
| return true; | ||
| } | ||
|
|
||
| @Kroll.method | ||
| public void flush() | ||
| { | ||
| HttpResponseCache cache = HttpResponseCache.getInstalled(); | ||
| if (cache != null) { | ||
| cache.flush(); | ||
| } | ||
| } | ||
|
|
||
| @Kroll.method | ||
| public void remove() throws IOException | ||
| { | ||
| HttpResponseCache cache = HttpResponseCache.getInstalled(); | ||
| if (cache != null) { | ||
| cache.delete(); | ||
| } | ||
| } | ||
|
|
||
| @Kroll.method | ||
| public void close() throws IOException | ||
| { | ||
| HttpResponseCache cache = HttpResponseCache.getInstalled(); | ||
| if (cache != null) { | ||
| cache.close(); | ||
| } | ||
| } | ||
|
|
||
| @Kroll.method | ||
| public int getHitCount() | ||
| { | ||
| HttpResponseCache cache = HttpResponseCache.getInstalled(); | ||
| if (cache != null) { | ||
| return cache.getHitCount(); | ||
| } | ||
| return 0; | ||
| } | ||
|
|
||
| @Kroll.method | ||
| public int getNetworkCount() | ||
| { | ||
| HttpResponseCache cache = HttpResponseCache.getInstalled(); | ||
| if (cache != null) { | ||
| cache.getNetworkCount(); | ||
|
|
||
| } | ||
| return 0; | ||
| } | ||
|
|
||
| @Kroll.method | ||
| public int getRequestCount() | ||
| { | ||
| HttpResponseCache cache = HttpResponseCache.getInstalled(); | ||
| if (cache != null) { | ||
| return cache.getRequestCount(); | ||
| } | ||
| return 0; | ||
| } | ||
|
|
||
| @Kroll.method | ||
| public long size() | ||
| { | ||
| HttpResponseCache cache = HttpResponseCache.getInstalled(); | ||
| if (cache != null) { | ||
| return cache.size(); | ||
| } | ||
| return 0; | ||
|
There was a problem hiding this comment. Should this return There was a problem hiding this comment.
I think, we shouldn't mix it. |
||
| } | ||
|
|
||
| // clang-format off | ||
| @Kroll.method | ||
| @Kroll.getProperty | ||
| public String getHttpCachePath() | ||
|
There was a problem hiding this comment.
|
||
| // clang-format on | ||
| { | ||
| return httpCachePath; | ||
| } | ||
|
|
||
| // clang-format off | ||
| @Kroll.method | ||
| @Kroll.getProperty | ||
| public long getHttpCacheSize() | ||
|
There was a problem hiding this comment. I'm not real fond of the long name here. I assume it was used to not clash with the Why not just mirror the underlying API's use of Additionally, please note that we're going to be moving away from getter/setter methods that just wrap properties in favor of using typical JS property accessors. So in this case, that'd be removing the |
||
| // clang-format on | ||
| { | ||
| return httpCacheSize; | ||
| } | ||
|
|
||
| // clang-format off | ||
| @Kroll.method | ||
| @Kroll.setProperty | ||
| public void setHttpCachePath(String value) | ||
|
There was a problem hiding this comment. Again, not fond of the long name. Why not just use Also, the setter method would be deprecated in 8.0.0 immediately anyhow. So maybe just use this as the There was a problem hiding this comment.
|
||
| // clang-format on | ||
| { | ||
| httpCachePath = value; | ||
| } | ||
|
|
||
| // clang-format off | ||
| @Kroll.method | ||
| @Kroll.setProperty | ||
| public void setHttpCacheSize(long value) | ||
|
There was a problem hiding this comment.
|
||
| // clang-format on | ||
| { | ||
| httpCacheSize = value; | ||
| } | ||
|
|
||
| @Override | ||
| public String getApiName() | ||
| { | ||
| return "Ti.Android.HttpResponseCache"; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not have the
path(orhttpCacheDir) property value determine the directory and relative path to store the cache?I'm worried here because the Android docs point out that if the requests contain private data, the external cache dir is a bad place to stick the cache due to access controls not being enforced on external storage.
I'm assuming it's because we don't actually expose the external cache dir anywhere in our APIs? cc @garymathews @jquick-axway
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. Also this is how currently
cacheDircalculated forTiResponseCache.