image_cache

assets/schema/ensemble_schema.json

@@ -753,6 +753,10 @@
           "type": "string",
           "description": "A unique identifier for this widget"
         },
+       "cache": {
+          "type": "boolean",
+          "description": "To put the image in the cache"
+        },
         "source": {
           "type": "string",
           "description": "URL to or asset name of the image. If the URL is used, it is highly recommended that the dimensions is set (either with width/height or other means) to prevent the UI jerkiness while loading."

lib/widget/image.dart

@@ -1,5 +1,4 @@
 import 'dart:io';
-import 'dart:math';
 
 import 'package:cached_network_image/cached_network_image.dart';
 import 'package:ensemble/action/haptic_action.dart';
@@ -11,14 +10,15 @@ import 'package:ensemble/screen_controller.dart';
 import 'package:ensemble/util/utils.dart';
 import 'package:ensemble/widget/helpers/controllers.dart';
 import 'package:ensemble/widget/helpers/widgets.dart';
-import 'package:ensemble/widget/widget_util.dart';
 import 'package:ensemble_ts_interpreter/invokables/invokable.dart';
 import 'package:flutter/cupertino.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_cache_manager/flutter_cache_manager.dart';
 import 'package:flutter_svg/svg.dart';
+import 'package:http_parser/http_parser.dart';
 import 'package:mime/mime.dart';
+import 'package:http/http.dart' as http;
 
 class EnsembleImage extends StatefulWidget
     with Invokable, HasController<ImageController, ImageState> {
@@ -51,6 +51,8 @@ class EnsembleImage extends StatefulWidget
   @override
   Map<String, Function> setters() {
     return {
+      'cache': (value) =>
+          _controller.cache = Utils.getBool(value, fallback: true),
       'source': (value) =>
           _controller.source = Utils.getString(value, fallback: ''),
       'fit': (value) => _controller.fit = Utils.getBoxFit(value),
@@ -75,6 +77,7 @@ class ImageController extends BoxController {
     /// the image will bleed through the borderRadius
     clipContent = true;
   }
+  DateTime? lastModifiedCache;
   String source = '';
   BoxFit? fit;
   Color? placeholderColor;
@@ -86,6 +89,7 @@ class ImageController extends BoxController {
   int? resizedWidth;
   int? resizedHeight;
   dynamic fallback;
+  bool cache = true;
 }
 
 class ImageState extends WidgetState<EnsembleImage> {
@@ -135,6 +139,20 @@ class ImageState extends WidgetState<EnsembleImage> {
     return rtn;
   }
 
+  Future<String> fetch(String url) async {
+    final http.Response response = await http
+        .get(Uri.parse("${url}timeStamp=${DateTime.now().toString()}"));
+    DateTime lastModifiedDateTime =
+        parseHttpDate("${response.headers['last-modified']}");
+    if (widget._controller.lastModifiedCache == null ||
+        lastModifiedDateTime.compareTo(widget._controller.lastModifiedCache!) ==
+            1) {
+      widget._controller.lastModifiedCache = lastModifiedDateTime;
+      await EnsembleImageCacheManager.instance.emptyCache();
+    }
+    return "${widget.controller.source}timeStamp=$lastModifiedDateTime";
+  }
+
   Widget buildNonSvgImage(String source, BoxFit? fit) {
     if (source.startsWith('https://') || source.startsWith('http://')) {
       int? cachedWidth = widget._controller.resizedWidth;
@@ -147,24 +165,46 @@ class ImageState extends WidgetState<EnsembleImage> {
         cachedWidth = 800;
       }
 
-      return CachedNetworkImage(
-        imageUrl: source,
-        width: widget._controller.width?.toDouble(),
-        height: widget._controller.height?.toDouble(),
-        fit: fit,
-
-        // we auto resize and cap these values so loading lots of
-        // gigantic images won't run out of memory
-        memCacheWidth: cachedWidth,
-        memCacheHeight: cachedHeight,
-        cacheManager: EnsembleImageCacheManager.instance,
-        errorWidget: (context, error, stacktrace) => errorFallback(),
-        placeholder: (context, url) => ColoredBoxPlaceholder(
-          color: widget._controller.placeholderColor,
+      Widget cacheImage(String url) {
+        return CachedNetworkImage(
+          imageUrl: url,
           width: widget._controller.width?.toDouble(),
           height: widget._controller.height?.toDouble(),
-        ),
-      );
+          fit: fit,
+          // we auto resize and cap these values so loading lots of
+          // gigantic images won't run out of memory
+          memCacheWidth: cachedWidth,
+          memCacheHeight: cachedHeight,
+          cacheManager: EnsembleImageCacheManager.instance,
+          errorWidget: (context, error, stacktrace) => errorFallback(),
+          placeholder: (context, url) => ColoredBoxPlaceholder(
+            color: widget._controller.placeholderColor,
+            width: widget._controller.width?.toDouble(),
+            height: widget._controller.height?.toDouble(),
+          ),
+        );
+      }
+
+      return (widget.controller.cache)
+          ? FutureBuilder(
+              future: fetch(widget.controller.source),
+              initialData: widget._controller.source,
+              builder: (context, snapshot) {
+                if (snapshot.connectionState == ConnectionState.done) {
+                  if (snapshot.hasData) {
+                    return cacheImage(snapshot.data!);
+                  } else {
+                    return cacheImage(widget.controller.source);
+                  }
+                } else {
+                  return ColoredBoxPlaceholder(
+                    color: widget._controller.placeholderColor,
+                    width: widget._controller.width?.toDouble(),
+                    height: widget._controller.height?.toDouble(),
+                  );
+                }
+              })
+          : cacheImage(widget._controller.source);
     } else if (Utils.isMemoryPath(widget._controller.source)) {
       return kIsWeb
           ? Image.network(widget._controller.source,