ota_update

Description:

ota update

ota_update #

Flutter plugin implementing OTA update.
On Android it downloads the file (with progress reporting) and triggers app installation intent.
On iOS it opens safari with specified ipa url. (not yet functioning)
Migrating to 5.0.0+ #
This update removes legacy support for flutter android embedding v1. No one should be affected now. In a rare event you are still using old ombedding, plese consider upgrading to v2.
Migrating to 4.0.0+ #
This update solves many problems arising from using android download manager and saving to external downloads folder.
Important changes:

Files are no longer downloaded using DownloadManager

Because we are not using download manager there is no default system notification about progress. Hovewer since update events are published to flutter code, you can implement notification yourself if needed.


Files are saved in internal directory which eliminates need to use SAF and prevents from multiple applications that uses this package to potentially overwrite apk

After upgrading version number, you need to replace contents of the file android/src/main/res/xml/filepaths.xml with following contents.
<?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>
copied to clipboard
Usage #
To use this plugin, add ota_update as a dependency in your pubspec.yaml file.
Example #
// IMPORT PACKAGE
import 'package:ota_update/ota_update.dart';

// RUN OTA UPDATE
// START LISTENING FOR DOWNLOAD PROGRESS REPORTING EVENTS
try {
//LINK CONTAINS APK OF FLUTTER HELLO WORLD FROM FLUTTER SDK EXAMPLES
OtaUpdate()
.execute(
'https://internal1.4q.sk/flutter_hello_world.apk',
// OPTIONAL
destinationFilename: 'flutter_hello_world.apk',
//OPTIONAL, ANDROID ONLY - ABILITY TO VALIDATE CHECKSUM OF FILE:
sha256checksum: "d6da28451a1e15cf7a75f2c3f151befad3b80ad0bb232ab15c20897e54f21478",
).listen(
(OtaEvent event) {
setState(() => currentEvent = event);
},
);
} catch (e) {
print('Failed to make OTA update. Details: $e');
}
copied to clipboard
Android #
Add permissions to AndroidManifest.xml.
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES"/>
copied to clipboard
Add following provider referrence to AndroidManifest.xml inside <application> node.
<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>
copied to clipboard
See AndroidManifest.xml in example
Also, create the file android/src/main/res/xml/filepaths.xml with following contents.
This will allow plugin to access the downloads folder to start the update.
<?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>
copied to clipboard
See filepaths.xml in example
Non-https traffic #
Cleartext traffic is disabled by Android download manager by default for security reasons. To allow it you need to create file res/xml/network_security_config.xml
<?xml version="1.0" encoding="utf-8"?>
<network-security-config>
<base-config cleartextTrafficPermitted="true" />
</network-security-config>
copied to clipboard
and reference it in AndroidManifest.xml in application tag
android:networkSecurityConfig="@xml/network_security_config"
copied to clipboard
Typical workflow
Since this plugin only handles download and instalation, there are still a few steps out of our scope that needs to be done. This is mainly to allow different implementation scenarios.

Update hosting. You need to hava server that provides you with installation file.
Checking for update. You need to have a way to check if the update is available.
Authentication. If your update server requires login you may need to obtain authorization token (or anything else you are using for auth) before downloading APK.
Download and installation of APK. This is the part that is provided for you by plugin.

Using sha256checksum
This package supports sha256 checksum verification of the file integrity. This allows as to detect if file has been corrupted durring transfer.
To use this feature, your update server should provide you with sha256 checksum of APK and you need to obtain this value while you are checking for update. When you run execute method with this parameter, plugin will compute sha256 value from downloaded file and compare with provided value. The update will continiue only if the two values match, otherwise it throws error.
Using split apks (experimental)
Plugin now allows you to get android ABI platform. If your are building multiple apks per abi (using flutter param --split-per-abi), you can now utilize smaller APKs. You can get system architecture and choose to download smaller APK
Notes

Google Play Protect may in some cases cause problems with installation.

Statuses #

DOWNLOADING:

status for events during downloading phase
event value is download progress percentage


INSTALLING:

event status that is sent just before triggering installation intent
event value is null


ALREADY_RUNNING_ERROR:

sent when 'execute' method is called before previous run finished
event value is null


PERMISSION_NOT_GRANTED_ERROR:

sent when user refused to grant required permissions
event value is null.


DOWNLOAD_ERROR

sent when download crashed.


CHECKSUM_ERROR (android only)

sent if calculated SHA-256 checksum does not match provided (optional) value
sent if checksum value should be verified, but checksum calculation failed


INTERNAL_ERROR:

sent in all other error cases
event value is underlying error message


CANCELED:

sent when the download was canceled using 'OtaUpdate().cancel()'



TODO #

restrict download to specific connection type (mobile, wifi)

Contribution and Support #

Contributions are welcome!
If you find a bug or want a feature, please fill an issue
If you want to contribute code please create a PR

PR guidelines #

Please do not change version in pubspec.yaml nor update CHANGELOG.md - this will be done before release of new version as release may contain multiple fixes and/or features. This will prevent some potential (yet simple) merge conflicts.