SMS message exporting, slightly better perf on win

Author: mrrfv

.gitignore

@@ -2,4 +2,6 @@
 *.env
 *-tmp
 *.apk
-hooks.sh
+hooks.sh
+.vscode
+.idea

README.md

@@ -11,6 +11,7 @@ Linux Android Backup is a tiny shell script & Flutter app that makes securely ba
 - Apps (.apk files of installed apps)
 - Internal storage (pictures, downloads, videos, Signal backups if enabled, etc)
 - Contacts (exported in vCard format)
+- SMS Messages (exported in CSV format; currently cannot be restored to a new device, viewable by opening the backup archive)
 
 These 3 things are the majority of what most people would want to keep safe, but everybody has different expectations and requirements, so suggestions are welcome.
 

backup-windows.ps1

@@ -8,7 +8,7 @@ Write-Output "Installing dependencies and setting up environment..."
 wsl sudo apt update
 wsl sudo apt install p7zip-full curl bc dos2unix pv kdialog -y
 Write-Output "Converting files - this may take several minutes..."
-wsl bash -c "sudo find ./ -type f -print0 | sudo xargs -0 dos2unix --"
+wsl bash -c "sudo find ./ -name '*.sh' -type f -print0 | sudo xargs -0 dos2unix --"
 Clear-Host
 Write-Output "Ready to run the backup script."
 pause

companion_app/android/app/src/main/AndroidManifest.xml

@@ -5,6 +5,8 @@
     <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
     <uses-permission android:maxSdkVersion="29" android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
     <uses-permission android:name="android.permission.MANAGE_EXTERNAL_STORAGE" />
+    <uses-permission android:name="android.permission.READ_SMS" />
+    
     <application
         android:requestLegacyExternalStorage="true"
         android:label="Linux Android Backup Companion"

companion_app/lib/main.dart

@@ -1,6 +1,8 @@
 import 'package:flutter/material.dart';
 import 'package:flutter_contacts/flutter_contacts.dart';
 import 'package:permission_handler/permission_handler.dart';
+import 'package:flutter_sms_inbox/flutter_sms_inbox.dart';
+import 'package:csv/csv.dart';
 import "dart:io";
 
 import 'package:device_info_plus/device_info_plus.dart';
@@ -40,6 +42,8 @@ class _HomeState extends State<Home> {
   bool showBackupProgress = false;
   int contactsAmountDatabase = 0;
   int contactsExported = 0;
+  int smsMessageCount = 0;
+  int smsMessagesExported = 0;
   // for restores
   bool showRestoreProgress = false;
   int contactsAmountFilesystem = 0;
@@ -48,7 +52,11 @@ class _HomeState extends State<Home> {
   Future<void> backup(BuildContext context) async {
     // Requests contacts & internal storage permissions
     if (await FlutterContacts.requestPermission() &&
-        await Permission.storage.request().isGranted) {
+        await Permission.storage.request().isGranted &&
+        await Permission.sms.request().isGranted) {
+      // create an instance of the SmsQuery class
+      SmsQuery sms = SmsQuery();
+
       // On Android 11 and later, request additional permissions.
       if ((await DeviceInfoPlugin().androidInfo).version.sdkInt! > 29 &&
           !await Permission.manageExternalStorage.request().isGranted) {
@@ -88,12 +96,40 @@ class _HomeState extends State<Home> {
         });
       }
 
+      // Export SMS messages.
+      List<SmsMessage> messages = await sms.getAllSms;
+
+      setState(() {
+        smsMessageCount = messages.length;
+      });
+
+      // Process messages so they can be saved to a CSV file.
+      List<List<String>> processedMessages = [];
+      processedMessages.add(["ID", "Address", "Body", "Date"]);
+      for (var i = 0; i < messages.length; i++) {
+        List<String> message = [
+          messages[i].id.toString(),
+          messages[i].address.toString(),
+          messages[i].body.toString(),
+          messages[i].date.toString(),
+        ];
+        processedMessages.add(message);
+        setState(() {
+          smsMessagesExported = i + 1;
+        });
+      }
+      String csv = const ListToCsvConverter().convert(processedMessages);
+
+      final File sms_file_export = File(
+          "/storage/emulated/0/linux-android-backup-temp/SMS_Messages.csv");
+      sms_file_export.writeAsString(csv);
+
       // Show a dialog if the export is complete
       showInfoDialog(context, "Data Exported",
           "Please continue the backup process on your computer.");
     } else {
       showInfoDialog(context, "Error",
-          "Storage and/or contacts permissions have not been granted.");
+          "Storage, SMS or contacts permissions have not been granted.");
     }
   }
 
@@ -191,7 +227,11 @@ class _HomeState extends State<Home> {
                     contactsExported.toString() +
                     " contact(s) out of " +
                     contactsAmountDatabase.toString() +
-                    ".")),
+                    ". Found " +
+                    smsMessageCount.toString() +
+                    " SMS messages to process, of which " +
+                    smsMessagesExported.toString() +
+                    " have been exported.")),
             const Divider(
               color: Color.fromARGB(31, 44, 44, 44),
               height: 25,
@@ -200,7 +240,7 @@ class _HomeState extends State<Home> {
               endIndent: 5,
             ),
             const Text(
-              "Upon restoring a backup, press the button below to automatically import all contacts.",
+              "Upon restoring a backup, press the button below to automatically import all contacts. SMS message importing isn't currently available, but you can view your messages by opening your backup archive.",
             ),
             ElevatedButton(
               onPressed: () {

companion_app/pubspec.lock

@@ -36,6 +36,13 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "1.16.0"
+  csv:
+    dependency: "direct main"
+    description:
+      name: csv
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "5.0.1"
   device_info_plus:
     dependency: "direct main"
     description:
@@ -118,6 +125,13 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "1.0.4"
+  flutter_sms_inbox:
+    dependency: "direct main"
+    description:
+      name: flutter_sms_inbox
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.0.2"
   flutter_test:
     dependency: "direct dev"
     description: flutter

companion_app/pubspec.yaml

@@ -37,6 +37,8 @@ dependencies:
   flutter_contacts: ^1.1.5
   permission_handler: ^8.3.0
   device_info_plus: ^3.2.0
+  flutter_sms_inbox: ^1.0.2
+  csv: ^5.0.1
 
 dev_dependencies:
   flutter_test:

functions/backup_func.sh

@@ -51,13 +51,14 @@ function backup_func() {
 	)
   done
 
-  # Export contacts
-  cecho "Exporting contacts (as vCard)."
+  # Export contacts and SMS messages
+  cecho "Exporting contacts (as vCard) and SMS messages (as CSV)."
   mkdir ./backup-tmp/Contacts
+  mkdir ./backup-tmp/SMS
   get_file /storage/emulated/0/linux-android-backup-temp . ./backup-tmp/Contacts
+  mv ./backup-tmp/Contacts/SMS_Messages.csv ./backup-tmp/SMS
   cecho "Removing temporary files created by the companion app."
   adb shell rm -rf /storage/emulated/0/linux-android-backup-temp
-
   # Export internal storage. We're not using adb pull due to reliability issues
   cecho "Exporting internal storage - this will take a while."
   mkdir ./backup-tmp/Storage
@@ -102,5 +103,7 @@ function backup_func() {
   fi
 
   cecho "Backed up successfully."
+  cecho "Note: SMS messages cannot be restored by Linux Android Backup at the moment. They are included in the backup archive for your own purposes."
+  cecho "You can find them by opening the backup archive using 7-Zip and navigating to the 'SMS' directory. This data can be opened in LibreOffice or Microsoft Excel."
   rm -rf backup-tmp > /dev/null
 }

website/fonts/OFL.txt

@@ -1,4 +1,4 @@
-Copyright 2019 The Baloo 2 Project Authors (https://github.com/EkType/Baloo2)
+Copyright 2019 The Baloo 2 Project Authors (https://github.com/EkType/Baloo2)
 
 This Font Software is licensed under the SIL Open Font License, Version 1.1.
 This license is copied below, and is also available with a FAQ at: