Add image caching to SmallImageCard #319
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| /* | ||
| Copyright 2024 Adobe. All rights reserved. | ||
| This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. You may obtain a copy | ||
| of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software distributed under | ||
| the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| OF ANY KIND, either express or implied. See the License for the specific language | ||
| governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| package com.adobe.marketing.mobile.messaging | ||
|
|
||
| import android.graphics.Bitmap | ||
| import android.graphics.BitmapFactory | ||
| import com.adobe.marketing.mobile.aepcomposeui.utils.UIUtils | ||
| import com.adobe.marketing.mobile.messaging.MessagingConstants.CACHE_EXPIRY_TIME | ||
| import com.adobe.marketing.mobile.messaging.MessagingConstants.CONTENT_CARD_CACHE_SUBDIRECTORY | ||
| import com.adobe.marketing.mobile.services.Log | ||
| import com.adobe.marketing.mobile.services.ServiceProvider | ||
| import com.adobe.marketing.mobile.services.caching.CacheEntry | ||
| import com.adobe.marketing.mobile.services.caching.CacheExpiry | ||
| import com.adobe.marketing.mobile.services.caching.CacheResult | ||
| import com.adobe.marketing.mobile.services.caching.CacheService | ||
| import java.io.InputStream | ||
| import java.nio.ByteBuffer | ||
|
|
||
| class ContentCardImageManager { | ||
|
Check warning on line 28 in code/messaging/src/main/java/com/adobe/marketing/mobile/messaging/ContentCardImageManager.kt
|
||
|
There was a problem hiding this comment. Whole class can be made as an object instead of class, and we can remove the companion object. |
||
| companion object { | ||
| private val SELF_TAG: String = "ContentCardManager" | ||
| private val cacheService: CacheService? = ServiceProvider.getInstance().cacheService | ||
| private val defaultCacheName: String = CONTENT_CARD_CACHE_SUBDIRECTORY | ||
|
|
||
| /** | ||
| * Fetches the image from cache if present in cache, else downloads the image from the given URL and caches it for future calls. | ||
| * | ||
| * @param imageUrl the url of the image to be fetched | ||
| * @param cacheName(optional) the name of the cache for fetching or caching the image, default value used if cache name is not provided | ||
| * @param completion is a completion callback. Result.success() method is invoked with the image bitmap fetched. In case of any failure, Result.failure() method is invoked with a throwable | ||
| * */ | ||
| fun getContentCardImageBitmap(imageUrl: String, cacheName: String? = defaultCacheName, completion: (Result<Bitmap>) -> Unit) { | ||
| val resolvedCacheName: String = cacheName ?: defaultCacheName | ||
| if (isImageCached(imageUrl, resolvedCacheName)) { | ||
| getImageBitmapFromCache(imageUrl, resolvedCacheName, completion) | ||
| } else { | ||
| downloadAndCacheImageBitmap(imageUrl, resolvedCacheName, completion) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Checks whether the image at given url is present in the cache or not. | ||
| * | ||
| * @param imageUrl the url of the image | ||
| * @param cacheName the name of the cache for fetching or caching the image | ||
| * @return `True` if the image is found in cache, `False` otherwise | ||
| * */ | ||
| private fun isImageCached(imageUrl: String, cacheName: String): Boolean { | ||
| val cacheValue = cacheService?.get(cacheName, imageUrl) | ||
| return cacheValue != null | ||
| } | ||
|
|
||
| /** | ||
| * Fetches the image from the cache. | ||
| * | ||
| * @param imageUrl the url of the image to be fetched | ||
| * @param cacheName the name of the cache for fetching the image | ||
| * @param completion is a completion callback. Result.success() method is invoked with the image bitmap fetched. In case of any failure, Result.failure() method is invoked with a throwable | ||
| * */ | ||
| private fun getImageBitmapFromCache(imageUrl: String, cacheName: String, completion: (Result<Bitmap>) -> Unit) { | ||
| val cachedImageBitmap: CacheResult? = cacheService?.get(cacheName, imageUrl) | ||
| val inputStream = cachedImageBitmap?.data | ||
|
|
||
| // Convert the InputStream to a Bitmap | ||
| if (inputStream != null) { | ||
| try { | ||
| completion(Result.success(BitmapFactory.decodeStream(inputStream))) | ||
| } catch (e: Exception) { | ||
| Log.warning( | ||
| MessagingConstants.LOG_TAG, | ||
| SELF_TAG, | ||
| "getImageBitmapFromCache - Unable to read cached data into a bitmap due to error: $e" | ||
|
Check warning on line 81 in code/messaging/src/main/java/com/adobe/marketing/mobile/messaging/ContentCardImageManager.kt
|
||
| ) | ||
| completion(Result.failure(e)) | ||
|
Check warning on line 83 in code/messaging/src/main/java/com/adobe/marketing/mobile/messaging/ContentCardImageManager.kt
|
||
| } | ||
| } else { | ||
| Log.warning( | ||
| MessagingConstants.LOG_TAG, | ||
| SELF_TAG, | ||
| "getImageBitmapFromCache - Unable to read cached data as the inputStream is null" | ||
|
Check warning on line 89 in code/messaging/src/main/java/com/adobe/marketing/mobile/messaging/ContentCardImageManager.kt
|
||
| ) | ||
| completion(Result.failure(Exception("Unable to read cached bitmap data as the inputStream is null for the url: $imageUrl, cacheName: $cacheName"))) | ||
|
Check warning on line 91 in code/messaging/src/main/java/com/adobe/marketing/mobile/messaging/ContentCardImageManager.kt
|
||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Downloads the image from the given url and caches it. | ||
| * | ||
| * @param imageUrl the url of the image to be downloaded | ||
| * @param completion is a completion callback. Result.success() method is invoked with the image bitmap downloaded. In case of any failure, Result.failure() method is invoked with a throwable | ||
| * */ | ||
| private fun downloadAndCacheImageBitmap(imageUrl: String, cacheName: String, completion: (Result<Bitmap>) -> Unit) { | ||
| UIUtils.downloadImage(imageUrl) { | ||
| it.onSuccess { bitmap -> | ||
| val isImageCacheSuccessful = cacheImage(bitmap, imageUrl, cacheName) | ||
| if (!isImageCacheSuccessful) { | ||
| Log.warning( | ||
| MessagingConstants.LOG_TAG, | ||
| SELF_TAG, | ||
| "downloadAndCacheImageBitmap - Image downloaded but failed to cache the image from url: $imageUrl" | ||
|
Check warning on line 109 in code/messaging/src/main/java/com/adobe/marketing/mobile/messaging/ContentCardImageManager.kt
|
||
| ) | ||
| } | ||
| completion(Result.success(bitmap)) | ||
| } | ||
| it.onFailure { failure -> | ||
| Log.warning( | ||
| MessagingConstants.LOG_TAG, | ||
| SELF_TAG, | ||
| "downloadAndCacheImageBitmap - Unable to download image from url: $imageUrl" | ||
| ) | ||
| completion(Result.failure(failure)) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Caches the given image. | ||
| * | ||
| * @param imageBitmap image to be cached | ||
| * @param imageName the unique `key` for storing the image in cache | ||
| * @param cacheName name of the cache where cache entry is to be created | ||
| * | ||
| * @return `True` if image is caches successfully, `False` otherwise | ||
| * */ | ||
| private fun cacheImage(imageBitmap: Bitmap, imageName: String, cacheName: String): Boolean { | ||
| try { | ||
| val imageInputStream: InputStream = imageBitmap.let { bitmap -> | ||
| val byteArray = ByteArray(bitmap.byteCount) | ||
| val buffer = ByteBuffer.wrap(byteArray) | ||
| bitmap.copyPixelsToBuffer(buffer) | ||
| buffer.rewind() // Reset the buffer position to the beginning | ||
| byteArray.inputStream() // Create InputStream from byte array | ||
| } | ||
|
|
||
| val cacheEntry = CacheEntry(imageInputStream, CacheExpiry.after(CACHE_EXPIRY_TIME), null) | ||
| cacheService?.set(cacheName, imageName, cacheEntry) | ||
|
|
||
| return true | ||
| } catch (e: Exception) { | ||
| Log.warning( | ||
| MessagingConstants.LOG_TAG, | ||
| SELF_TAG, | ||
| "cacheImage - An unexpected error occurred while caching the downloaded image: \n ${e.localizedMessage}" | ||
|
Check warning on line 152 in code/messaging/src/main/java/com/adobe/marketing/mobile/messaging/ContentCardImageManager.kt
|
||
| ) | ||
| return false | ||
|
Check warning on line 154 in code/messaging/src/main/java/com/adobe/marketing/mobile/messaging/ContentCardImageManager.kt
|
||
| } | ||
| } | ||
| } | ||
| } | ||
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.
this function can also be added to the companion object so it can be called statically.