save screenshot & added comments

EnsembleUI · Jan 13, 2025 · 9912d03 · 9912d03
1 parent dc11aed
commit 9912d03
Show file tree

Hide file tree

Showing 3 changed files with 96 additions and 72 deletions.
diff --git a/modules/ensemble/lib/action/saveFile/save_file.dart b/modules/ensemble/lib/action/saveFile/save_file.dart
@@ -1,17 +1,13 @@
 import 'dart:convert';
 import 'dart:typed_data';
-import 'dart:io';
 
 import 'package:ensemble/framework/action.dart';
 import 'package:ensemble/framework/scope.dart';
 import 'package:flutter/material.dart';
-import 'package:image_gallery_saver/image_gallery_saver.dart';
-import 'package:path_provider/path_provider.dart';
 import 'package:ensemble/framework/error_handling.dart';
 import 'package:flutter/foundation.dart';
 import 'package:http/http.dart' as http;
-// Conditionally import the file that has `dart:html` vs. the stub:
-import 'download_stub.dart' if (dart.library.html) 'download_web.dart';
+import 'save_mobile.dart';
 
 /// Custom action to save files (images and documents) in platform-specific accessible directories
 class SaveToFileSystemAction extends EnsembleAction {
@@ -73,79 +69,24 @@ class SaveToFileSystemAction extends EnsembleAction {
         throw Exception('Missing blobData and source.');
       }
 
-      if (type == 'image') {
-        // Save images to Default Image Path
-        await _saveImageToDCIM(fileName!, fileBytes);
-      } else if (type == 'document') {
-        // Save documents to Documents folder
-        await _saveDocumentToDocumentsFolder(fileName!, fileBytes);
-      }
+      // Save the file to the storage system
+      await _saveFile(type!, fileName!, fileBytes);
     } catch (e) {
       throw Exception('Failed to save file: $e');
     }
   }
 
-  Future<void> _saveImageToDCIM(String fileName, Uint8List fileBytes) async {
-    try {
-      if (kIsWeb) {
-        _downloadFileOnWeb(fileName, fileBytes);
-      } else {
-        final result = await ImageGallerySaver.saveImage(
-          fileBytes,
-          name: fileName,
-        );
-        if (result['isSuccess']) {
-          debugPrint('Image saved to gallery: $result');
-        } else {
-          throw Exception('Failed to save image to gallery.');
-        }
-      }
-    } catch (e) {
-      throw Exception('Failed to save image: $e');
+  Future<void> _saveFile(
+      String type, String fileName, Uint8List fileBytes) async {
+    if (type == 'image') {
+      // Save images to Default Image Path
+      await saveImageToDCIM(fileName!, fileBytes);
+    } else if (type == 'document') {
+      // Save documents to Documents folder
+      await saveDocumentToDocumentsFolder(fileName!, fileBytes);
     }
   }
 
-  /// Save documents to the default "Documents" directory
-  Future<void> _saveDocumentToDocumentsFolder(
-      String fileName, Uint8List fileBytes) async {
-    try {
-      String filePath;
-
-      if (Platform.isAndroid) {
-        // Get the default "Documents" directory on Android
-        Directory? directory = Directory('/storage/emulated/0/Documents');
-        if (!directory.existsSync()) {
-          directory.createSync(
-              recursive: true); // Create the directory if it doesn't exist
-        }
-        filePath = '${directory.path}/$fileName';
-      } else if (Platform.isIOS) {
-        // On iOS, use the app-specific Documents directory
-        final directory = await getApplicationDocumentsDirectory();
-        filePath = '${directory.path}/$fileName';
-
-        // Optionally, use a share intent to let users save the file to their desired location
-      } else if (kIsWeb) {
-        _downloadFileOnWeb(fileName, fileBytes);
-        return;
-      } else {
-        throw UnsupportedError('Platform not supported');
-      }
-
-      // Write the file to the determined path
-      final file = File(filePath);
-      await file.writeAsBytes(fileBytes);
-
-      debugPrint('Document saved to: $filePath');
-    } catch (e) {
-      throw Exception('Failed to save document: $e');
-    }
-  }
-
-  Future<void> _downloadFileOnWeb(String fileName, Uint8List fileBytes) async {
-    downloadFileOnWeb(fileName, fileBytes);
-  }
-
   /// Factory method to construct the action from JSON
   static SaveToFileSystemAction fromJson(Map<String, dynamic> json) {
     return SaveToFileSystemAction(

diff --git a/modules/ensemble/lib/action/saveFile/save_mobile.dart b/modules/ensemble/lib/action/saveFile/save_mobile.dart
@@ -0,0 +1,64 @@
+import 'dart:io';
+
+import 'package:flutter/foundation.dart';
+import 'package:image_gallery_saver/image_gallery_saver.dart';
+import 'package:path_provider/path_provider.dart';
+// Conditionally import the file that has `dart:html` vs. the stub:
+import 'download_stub.dart' if (dart.library.html) 'download_web.dart';
+
+Future<void> saveImageToDCIM(String fileName, Uint8List fileBytes) async {
+  try {
+    if (kIsWeb) {
+      downloadFileOnWeb(fileName, fileBytes);
+    } else {
+      final result = await ImageGallerySaver.saveImage(
+        fileBytes,
+        name: fileName,
+      );
+      if (result['isSuccess']) {
+        debugPrint('Image saved to gallery: $result');
+      } else {
+        throw Exception('Failed to save image to gallery.');
+      }
+    }
+  } catch (e) {
+    throw Exception('Failed to save image: $e');
+  }
+}
+
+/// Save documents to the default "Documents" directory
+Future<void> saveDocumentToDocumentsFolder(
+    String fileName, Uint8List fileBytes) async {
+  try {
+    String filePath;
+
+    if (Platform.isAndroid) {
+      // Get the default "Documents" directory on Android
+      Directory? directory = Directory('/storage/emulated/0/Documents');
+      if (!directory.existsSync()) {
+        directory.createSync(
+            recursive: true); // Create the directory if it doesn't exist
+      }
+      filePath = '${directory.path}/$fileName';
+    } else if (Platform.isIOS) {
+      // On iOS, use the app-specific Documents directory
+      final directory = await getApplicationDocumentsDirectory();
+      filePath = '${directory.path}/$fileName';
+
+      // Optionally, use a share intent to let users save the file to their desired location
+    } else if (kIsWeb) {
+      downloadFileOnWeb(fileName, fileBytes);
+      return;
+    } else {
+      throw UnsupportedError('Platform not supported');
+    }
+
+    // Write the file to the determined path
+    final file = File(filePath);
+    await file.writeAsBytes(fileBytes);
+
+    debugPrint('Document saved to: $filePath');
+  } catch (e) {
+    throw Exception('Failed to save document: $e');
+  }
+}
diff --git a/modules/ensemble/lib/action/take_screenshot.dart b/modules/ensemble/lib/action/take_screenshot.dart
@@ -6,8 +6,11 @@ import 'package:ensemble/framework/view/data_scope_widget.dart';
 import 'package:ensemble/screen_controller.dart';
 import 'package:ensemble/framework/scope.dart';
 import 'package:ensemble/util/utils.dart';
+import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
+import 'package:intl/intl.dart';
 import 'package:screenshot/screenshot.dart';
+import 'saveFile/save_mobile.dart';
 
 class TakeScreenshotAction extends EnsembleAction {
   TakeScreenshotAction({
@@ -59,6 +62,7 @@ class TakeScreenshotAction extends EnsembleAction {
       );
 
       final Uint8List? capturedImage =
+          // It will only capture readonly widgets
           await screenshotController.captureFromLongWidget(
         InheritedTheme.captureAll(
           context,
@@ -67,7 +71,6 @@ class TakeScreenshotAction extends EnsembleAction {
             child: widget,
           ),
         ),
-        delay: const Duration(milliseconds: 1000),
         pixelRatio: pixelRatio ?? MediaQuery.of(context).devicePixelRatio,
         context: context,
       );
@@ -77,13 +80,15 @@ class TakeScreenshotAction extends EnsembleAction {
       }
 
       final dimensions = await _getImageDimensions(capturedImage);
+      // Save screenshot to gallery and download on web
+      await _saveScreenshot(capturedImage);
 
       if (onSuccess != null) {
         await ScreenController().executeAction(
           context,
           onSuccess!,
           event: EnsembleEvent(initiator, data: {
-            'imageData': capturedImage,
+            'imageBytes': capturedImage, // capturedImage contains Image Bytes
             'size': capturedImage.length,
             'dimensions': dimensions,
           }),
@@ -101,6 +106,20 @@ class TakeScreenshotAction extends EnsembleAction {
     }
   }
 
+  Future<void> _saveScreenshot(Uint8List fileBytes) async {
+    // Screenshot name of current date
+    // Get the current date and time
+    DateTime now = DateTime.now();
+
+    // Format the date and time
+    String formattedDateTime = DateFormat('yyyyMMdd_HHmmss').format(now);
+
+    // Combine the prefix with the formatted date and time
+    String screenshotName = 'screenshot_$formattedDateTime';
+
+    await saveImageToDCIM(screenshotName, fileBytes);
+  }
+
   Future<Map<String, int>> _getImageDimensions(Uint8List imageData) async {
     final image = await decodeImageFromList(imageData);
     return {