Implement the automatic update check and installation

This commit is contained in:
zontreck 2025-05-14 19:05:09 -07:00
parent 70d8fc4d39
commit 660a4a670a
10 changed files with 176 additions and 122 deletions

View file

@ -9,6 +9,7 @@
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION"/>
<uses-permission android:name="android.permission.INSTALL_PACKAGES"/>
<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES"/>
<application
@ -42,6 +43,10 @@
<meta-data
android:name="flutterEmbedding"
android:value="2" />
<provider android:name="sk.fourq.otaupdate.OtaUpdateFileProvider" android:authorities="${applicationId}.ota_update_provider" android:exported="false" android:grantUriPermissions="true">
<meta-data android:name="android.support.FILE_PROVIDER_PATHS" android:resource="@xml/filepaths" />
</provider>
</application>
<!-- Required to query activities that can process text, see:
https://developer.android.com/training/package-visibility and

View file

@ -0,0 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
<files-path name="internal_apk_storage" path="ota_update/"/>
</paths>

View file

@ -1,3 +1,3 @@
{
"alpha": "1.0.0-dev.1"
"alpha": "1.0.0-dev.2"
}

35
lib/consts.dart Normal file
View file

@ -0,0 +1,35 @@
import 'dart:convert';
import 'package:dio/dio.dart';
class TTConsts {
static const UPDATE_URL =
"https://git.zontreck.com/AriasCreations/TimeTracker/raw/branch/main/latest-releases.json";
static const VERSION = "1.0.0-dev.2";
static bool UPDATE_AVAILABLE = false;
static UpdateChannel UPDATE_CHANNEL = UpdateChannel.alpha;
static Future<void> checkUpdate() async {
Dio dio = Dio();
var reply = await dio.get(UPDATE_URL);
var jsData = json.decode(reply.data as String);
String serverVersion = jsData[UPDATE_CHANNEL.toString()] as String;
if (VERSION == serverVersion) {
// Up to date
UPDATE_AVAILABLE = false;
} else
UPDATE_AVAILABLE = true;
}
}
enum UpdateChannel {
alpha,
beta,
stable;
@override
String toString() {
return name;
}
}

View file

@ -1,122 +1,9 @@
import 'package:flutter/material.dart';
import 'package:timetrack/consts.dart';
import 'package:timetrack/pages/MainApp.dart';
void main() {
runApp(const MyApp());
}
class MyApp extends StatelessWidget {
const MyApp({super.key});
// This widget is the root of your application.
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Flutter Demo',
theme: ThemeData(
// This is the theme of your application.
//
// TRY THIS: Try running your application with "flutter run". You'll see
// the application has a purple toolbar. Then, without quitting the app,
// try changing the seedColor in the colorScheme below to Colors.green
// and then invoke "hot reload" (save your changes or press the "hot
// reload" button in a Flutter-supported IDE, or press "r" if you used
// the command line to start the app).
//
// Notice that the counter didn't reset back to zero; the application
// state is not lost during the reload. To reset the state, use hot
// restart instead.
//
// This works for code too, not just values: Most code changes can be
// tested with just a hot reload.
colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
),
home: const MyHomePage(title: 'Flutter Demo Home Page'),
);
}
}
class MyHomePage extends StatefulWidget {
const MyHomePage({super.key, required this.title});
// This widget is the home page of your application. It is stateful, meaning
// that it has a State object (defined below) that contains fields that affect
// how it looks.
// This class is the configuration for the state. It holds the values (in this
// case the title) provided by the parent (in this case the App widget) and
// used by the build method of the State. Fields in a Widget subclass are
// always marked "final".
final String title;
@override
State<MyHomePage> createState() => _MyHomePageState();
}
class _MyHomePageState extends State<MyHomePage> {
int _counter = 0;
void _incrementCounter() {
setState(() {
// This call to setState tells the Flutter framework that something has
// changed in this State, which causes it to rerun the build method below
// so that the display can reflect the updated values. If we changed
// _counter without calling setState(), then the build method would not be
// called again, and so nothing would appear to happen.
_counter++;
});
}
@override
Widget build(BuildContext context) {
// This method is rerun every time setState is called, for instance as done
// by the _incrementCounter method above.
//
// The Flutter framework has been optimized to make rerunning build methods
// fast, so that you can just rebuild anything that needs updating rather
// than having to individually change instances of widgets.
return Scaffold(
appBar: AppBar(
// TRY THIS: Try changing the color here to a specific color (to
// Colors.amber, perhaps?) and trigger a hot reload to see the AppBar
// change color while the other colors stay the same.
backgroundColor: Theme.of(context).colorScheme.inversePrimary,
// Here we take the value from the MyHomePage object that was created by
// the App.build method, and use it to set our appbar title.
title: Text(widget.title),
),
body: Center(
// Center is a layout widget. It takes a single child and positions it
// in the middle of the parent.
child: Column(
// Column is also a layout widget. It takes a list of children and
// arranges them vertically. By default, it sizes itself to fit its
// children horizontally, and tries to be as tall as its parent.
//
// Column has various properties to control how it sizes itself and
// how it positions its children. Here we use mainAxisAlignment to
// center the children vertically; the main axis here is the vertical
// axis because Columns are vertical (the cross axis would be
// horizontal).
//
// TRY THIS: Invoke "debug painting" (choose the "Toggle Debug Paint"
// action in the IDE, or press "p" in the console), to see the
// wireframe for each widget.
mainAxisAlignment: MainAxisAlignment.center,
children: <Widget>[
const Text('You have pushed the button this many times:'),
Text(
'$_counter',
style: Theme.of(context).textTheme.headlineMedium,
),
],
),
),
floatingActionButton: FloatingActionButton(
onPressed: _incrementCounter,
tooltip: 'Increment',
child: const Icon(Icons.add),
), // This trailing comma makes auto-formatting nicer for build methods.
);
}
Future<void> main() async {
await TTConsts.checkUpdate();
runApp(MainApp());
}

80
lib/pages/HomePage.dart Normal file
View file

@ -0,0 +1,80 @@
import 'package:flutter/material.dart';
import 'package:flutter/widgets.dart';
import 'package:libacflutter/Constants.dart';
import 'package:ota_update/ota_update.dart';
import 'package:timetrack/consts.dart';
class HomePage extends StatefulWidget {
HomePage({super.key});
@override
State<StatefulWidget> createState() {
return _HomePageState();
}
}
class _HomePageState extends State<HomePage> {
@override
void didChangeDependencies() {
setState(() {});
super.didChangeDependencies();
}
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text("Time Tracker"),
backgroundColor: LibACFlutterConstants.TITLEBAR_COLOR,
),
drawer: Drawer(
elevation: 8,
child: Column(
children: [
DrawerHeader(
child: Column(
children: [
Text("Time Tracker"),
Text("Created by Tara Piccari"),
Text("Copyright 2025 - Present"),
],
),
),
DrawerHeader(
child: Column(
children: [
Text("Version: ${TTConsts.VERSION}"),
Text("Update Channel: ${TTConsts.UPDATE_CHANNEL}"),
Text(
"* ${TTConsts.UPDATE_AVAILABLE ? "Update Is Available" : "You are up to date!"} *",
),
ElevatedButton(
onPressed: () async {
await TTConsts.checkUpdate();
setState(() {});
},
child: Text("Check for Update"),
),
ElevatedButton(
onPressed: () async {
OtaUpdate()
.execute(
"https://ci.zontreck.com/job/Projects/job/Dart/job/Time%20Tracker/job/main/lastSuccessfulBuild/artifact/build/app/outputs/flutter-apk/timetrack.apk",
destinationFilename: "timetrack.apk",
)
.listen((OtaEvent event) {
//setState(() => currentEvent = event);
});
},
child: Text("Install Update"),
),
],
),
),
],
),
),
);
}
}

28
lib/pages/MainApp.dart Normal file
View file

@ -0,0 +1,28 @@
import 'package:flutter/material.dart';
import 'package:flutter/widgets.dart';
import 'package:timetrack/pages/HomePage.dart';
class MainApp extends StatefulWidget {
MainApp({super.key});
@override
State<StatefulWidget> createState() {
return MainAppState();
}
}
class MainAppState extends State<MainApp> {
@override
void didChangeDependencies() {
super.didChangeDependencies();
}
@override
Widget build(BuildContext context) {
return MaterialApp(
title: "Time Tracker",
routes: {"/": (ctx) => HomePage()},
theme: ThemeData.dark(),
);
}
}

View file

@ -40,6 +40,8 @@ dependencies:
libacflutter:
hosted: https://git.zontreck.com/api/packages/Packages/pub/
version: 1.0.31525+0222
dio: ^5.8.0+1
ota_update: ^7.0.1
dev_dependencies:
flutter_test:

View file

@ -0,0 +1,13 @@
import 'package:flutter_test/flutter_test.dart';
import 'package:timetrack/consts.dart';
void main() {
test("Test the update checking behavior", () async {
await TTConsts.checkUpdate();
if (TTConsts.UPDATE_AVAILABLE) {
print("An update is available for the current update channel");
} else {
print("No updates available");
}
});
}

View file

@ -8,12 +8,12 @@
import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:timetrack/main.dart';
import 'package:timetrack/pages/MainApp.dart';
void main() {
testWidgets('Counter increments smoke test', (WidgetTester tester) async {
// Build our app and trigger a frame.
await tester.pumpWidget(const MyApp());
await tester.pumpWidget(MainApp());
// Verify that our counter starts at 0.
expect(find.text('0'), findsOneWidget);