feature: build FOSS flavored app (#107)

feature: load changelog from GitHub
fix: remove unnecessary permissions

.github/workflows/release.yml

@@ -39,14 +39,17 @@ jobs:
       - name: Install Dependencies
         run: flutter pub get
 
+      - name: Generate localizations
+        run: flutter gen-l10n
+
       - name: Generate code
         run: flutter pub run build_runner build --delete-conflicting-outputs
 
-      - name: Reinstall Dependencies
-        run: flutter pub get
+      - name: FOSS-ify dependencies
+        run: flutter pub remove --offline in_app_review
 
       - name: Build APKs
-        run: flutter build apk --split-per-abi --obfuscate --split-debug-info=build/app/output/symbols
+        run: flutter build apk --flavor=foss -t lib/main.foss.dart --split-per-abi --obfuscate --split-debug-info=build/app/output/symbols
 
       - name: Upload ARM_EABI assets
         uses: actions/upload-release-asset@v1

.vscode/launch.json

@@ -0,0 +1,28 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "macos",
+      "request": "launch",
+      "type": "dart",
+      "program": "lib/main.dart"
+    },
+    {
+      "name": "google",
+      "request": "launch",
+      "type": "dart",
+      "program": "lib/main.google.dart",
+      "args": ["--flavor", "google", "-t", "lib/main.google.dart"]
+    },
+    {
+      "name": "foss",
+      "request": "launch",
+      "type": "dart",
+      "program": "lib/main.foss.dart",
+      "args": ["--flavor", "foss", "-t", "lib/main.foss.dart"]
+    }
+  ]
+}

CHANGELOG.md

@@ -30,16 +30,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Miscellaneous Chores
 
-* release 2.8.0 ([0350ff8](https://github.com/huffSamuel/upnp_explorer/commit/0350ff88990e1539557c90441913f7eaf1d71253))
 * release 2.8.1 ([308bb8c](https://github.com/huffSamuel/upnp_explorer/commit/308bb8c2b5e9d7cb590f9f233f4abe739d678005))
 
-## [2.8.0](https://github.com/huffSamuel/upnp_explorer/compare/v2.8.0...v2.8.0) (2024-02-17)
-
-
-### Miscellaneous Chores
-
-* release 2.8.0 ([0350ff8](https://github.com/huffSamuel/upnp_explorer/commit/0350ff88990e1539557c90441913f7eaf1d71253))
-
 ## [2.8.0](https://github.com/huffSamuel/upnp_explorer/compare/v2.7.0...v2.8.0) (2024-02-17)
 
 

android/app/build.gradle

@@ -32,6 +32,20 @@ if (keystorePropertiesFile.exists()) {
 android {
     compileSdkVersion 34
 
+    flavorDimensions "store"
+
+    productFlavors {
+        google {
+            dimension "store"
+            resValue "string", "app_name", "UPnP Explorer"
+        }
+        foss {
+            dimension "store"
+            resValue "string", "app_name", "UPnP Explorer (FOSS)"
+            versionNameSuffix "-FOSS"
+        }
+    }
+
     sourceSets {
         main.java.srcDirs += 'src/main/kotlin'
     }
@@ -62,6 +76,11 @@ android {
                 'proguard-rules.pro'
         }
     }
+
+    dependenciesInfo {
+        includeInApk = false
+        includeInBundle = false
+    }
 }
 
 flutter {

android/app/src/main/AndroidManifest.xml

@@ -2,7 +2,6 @@
     package="com.samueljhuf.upnp_explorer">
     <uses-permission android:name="android.permission.INTERNET"/>
     <uses-permission android:name="android.permission.CHANGE_WIFI_MULTICAST_STATE" />
-    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
 
     <queries>
     <intent>

lib/application/application.dart

@@ -1,8 +1,10 @@
 class Application {
   static const repoUrl = 'https://github.com/huffSamuel/upnp_explorer';
+  static const _blob = '$repoUrl/blob/main';
   static const submitBugUrl = '${repoUrl}/issues/new/choose';
   static const name = 'UPnP Explorer';
-  static const privacyPolicyUrl = '${repoUrl}/blob/main/PRIVACY_POLICY.md';
+  static const privacyPolicyUrl = '$_blob/PRIVACY_POLICY.md';
+  static const changelogUrl = '$_blob/CHANGELOG.md';
   static const appId = 'com.samueljhuf.upnp_explorer';
 
   static const assets = const Assets();

lib/application/changelog/changelog_service.dart

@@ -1,19 +1,28 @@
+import 'dart:io';
+
 import 'package:flutter/services.dart';
+import 'package:flutter_markdown/flutter_markdown.dart';
 import 'package:injectable/injectable.dart';
 import 'package:package_info_plus/package_info_plus.dart';
+import 'package:rxdart/rxdart.dart';
 import 'package:shared_preferences/shared_preferences.dart';
+import 'package:http/http.dart' as http;
+import 'package:upnp_explorer/application/application.dart';
 
 const String lastChangelogVersion = 'lastChangelogVersion';
 
 @lazySingleton
 class ChangelogService {
   final SharedPreferences prefs;
+  String? _changes;
 
   ChangelogService(this.prefs);
 
+  Future<String> version() async => (await PackageInfo.fromPlatform()).version;
+
   Future<bool> shouldDisplayChangelog() async {
     final lastDisplayed = prefs.getString(lastChangelogVersion);
-    final currentVersion = (await PackageInfo.fromPlatform()).version;
+    final currentVersion = await version();
 
     if (lastDisplayed != currentVersion) {
       await prefs.setString(lastChangelogVersion, currentVersion);
@@ -23,7 +32,29 @@ class ChangelogService {
     return false;
   }
 
-  Future<String> changes() async {
-    return rootBundle.loadString('assets/CHANGELOG.md');
+  Stream<String> changes() => Stream.fromFuture(futureChanges());
+
+  Future<String> futureChanges() async {
+    if (_changes == null) {
+      final currentVersion = await version();
+
+      final uri =
+          'https://raw.githubusercontent.com/huffSamuel/upnp_explorer/v$currentVersion/CHANGELOG.md';
+
+      final data = await http.get(Uri.parse(uri));
+
+      if (data.statusCode < 200 || data.statusCode > 299) {
+        throw LoadFailedException();
+      }
+
+      _changes = data.body
+          .split(Platform.lineTerminator)
+          .skipWhile((x) => !x.startsWith('##'))
+          .join(Platform.lineTerminator);
+    }
+
+    return _changes!;
   }
 }
+
+class LoadFailedException extends Error {}

lib/application/flavors/default_features.dart

@@ -0,0 +1,13 @@
+import 'package:upnp_explorer/application/flavors/flavor_features.dart';
+
+class DefaultFeatures extends FlavorFeatures {
+  @override
+  Future<void> openStoreListing() {
+    // TODO: implement openStoreListing
+    throw UnimplementedError();
+  }
+
+  @override
+  bool get showRatingTile => false;
+
+}

lib/application/flavors/flavor_features.dart

@@ -0,0 +1,4 @@
+abstract class FlavorFeatures {
+  Future<void> openStoreListing();
+  bool get showRatingTile;
+}

lib/application/flavors/foss/foss_features.dart

@@ -0,0 +1,9 @@
+import 'package:upnp_explorer/application/flavors/flavor_features.dart';
+
+class FossFeatures extends FlavorFeatures {
+  @override
+  Future<void> openStoreListing() => Future.value();
+
+  @override
+  bool get showRatingTile => false;
+}

lib/application/flavors/google/google_features.dart

@@ -0,0 +1,12 @@
+import 'package:in_app_review/in_app_review.dart';
+import 'package:upnp_explorer/application/application.dart';
+import 'package:upnp_explorer/application/flavors/flavor_features.dart';
+
+class GoogleFeatures extends FlavorFeatures {
+  @override
+  Future<void> openStoreListing() => InAppReview.instance.openStoreListing(appStoreId: Application.appId);
+
+  @override
+  bool get showRatingTile => true;
+
+}

lib/application/l10n/intl_en.arb

@@ -288,6 +288,7 @@
   "thisWillClearAllMessages": "This will clear all network message history.",
   "traffic": "Traffic",
   "turnOnWifi": "Turn on Wi-Fi",
+  "unableToLoadChangelog": "Unable to load changelog",
   "unableToObtainInformation": "Unable to obtain service information",
   "unableToSubmitFeedback": "Unable to submit feedback",
   "unavailable": "Unavailable",

lib/application/l10n/intl_es.arb

@@ -104,6 +104,7 @@
   "thisWillClearAllMessages": "Esto borrará todo el historial de mensajes de la red.",
   "traffic": "Tráfico",
   "turnOnWifi": "Activar wifi",
+  "unableToLoadChangelog": "No se puede cargar el registro de cambios",
   "unableToObtainInformation": "No se puede obtener la información del servicio",
   "unableToSubmitFeedback": "No se pueden enviar comentarios",
   "unavailable": "Indisponible",