feat: add Android impl

pull/536/head
Lucas Nogueira 2 years ago
parent 1397172e95
commit 0a96087c7b
No known key found for this signature in database
GPG Key ID: FFEA6C72E73482F1

12
Cargo.lock generated

@ -4824,6 +4824,18 @@ dependencies = [
"thiserror", "thiserror",
] ]
[[package]]
name = "tauri-plugin-barcode-scanner"
version = "0.0.0"
dependencies = [
"log",
"serde",
"serde_json",
"tauri",
"tauri-build",
"thiserror",
]
[[package]] [[package]]
name = "tauri-plugin-cli" name = "tauri-plugin-cli"
version = "0.0.0" version = "0.0.0"

@ -0,0 +1,18 @@
[package]
name = "tauri-plugin-barcode-scanner"
version = "0.0.0"
edition.workspace = true
authors.workspace = true
license.workspace = true
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[build-dependencies]
tauri-build.workspace = true
[dependencies]
serde.workspace = true
serde_json.workspace = true
tauri.workspace = true
log.workspace = true
thiserror.workspace = true

@ -0,0 +1,20 @@
SPDXVersion: SPDX-2.1
DataLicense: CC0-1.0
PackageName: tauri
DataFormat: SPDXRef-1
PackageSupplier: Organization: The Tauri Programme in the Commons Conservancy
PackageHomePage: https://tauri.app
PackageLicenseDeclared: Apache-2.0
PackageLicenseDeclared: MIT
PackageCopyrightText: 2019-2022, The Tauri Programme in the Commons Conservancy
PackageSummary: <text>Tauri is a rust project that enables developers to make secure
and small desktop applications using a web frontend.
</text>
PackageComment: <text>The package includes the following libraries; see
Relationship information.
</text>
Created: 2019-05-20T09:00:00Z
PackageDownloadLocation: git://github.com/tauri-apps/tauri
PackageDownloadLocation: git+https://github.com/tauri-apps/tauri.git
PackageDownloadLocation: git+ssh://github.com/tauri-apps/tauri.git
Creator: Person: Daniel Thompson-Yvetot

@ -0,0 +1,177 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2017 - Present Tauri Apps Contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

@ -0,0 +1,65 @@
![Barcode Scanner](banner.jpg)
<!-- description -->
## Install
_This plugin requires a Rust version of at least **1.64**_
There are three general methods of installation that we can recommend.
1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
2. Pull sources directly from Github using git tags / revision hashes (most secure)
3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)
Install the Core plugin by adding the following to your `Cargo.toml` file:
`src-tauri/Cargo.toml`
```toml
[dependencies]
tauri-plugin-barcode-scanner = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }
```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh
pnpm add tauri-plugin-barcode-scanner-api
# or
npm add tauri-plugin-barcode-scanner-api
# or
yarn add tauri-plugin-barcode-scanner-api
```
## Usage
First you need to register the core plugin with Tauri:
`src-tauri/src/main.rs`
```rust
fn main() {
tauri::Builder::default()
.plugin(tauri_plugin_barcode_scanner)
.run(tauri::generate_context!())
.expect("error while running tauri application");
}
```
Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
```javascript
```
## Contributing
PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
## License
Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
MIT or MIT/Apache 2.0 where applicable.

@ -0,0 +1,2 @@
/build
/.tauri

@ -0,0 +1,56 @@
plugins {
id("com.android.library")
id("org.jetbrains.kotlin.android")
}
android {
namespace = "app.tauri.barcodescanner"
compileSdk = 32
defaultConfig {
minSdk = 24
targetSdk = 32
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
consumerProguardFiles("consumer-rules.pro")
}
buildTypes {
release {
isMinifyEnabled = false
proguardFiles(
getDefaultProguardFile("proguard-android-optimize.txt"),
"proguard-rules.pro"
)
}
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8
}
kotlinOptions {
jvmTarget = "1.8"
}
}
dependencies {
implementation("androidx.core:core-ktx:1.9.0")
implementation("androidx.appcompat:appcompat:1.6.0")
implementation("com.google.android.material:material:1.7.0")
implementation("androidx.camera:camera-core:1.1.0")
implementation("androidx.camera:camera-view:1.1.0")
implementation("androidx.camera:camera-lifecycle:1.1.0")
implementation("androidx.camera:camera-camera2:1.1.0")
implementation("androidx.camera:camera-lifecycle:1.1.0")
implementation("androidx.camera:camera-view:1.1.0")
implementation("com.google.android.gms:play-services-mlkit-barcode-scanning:18.1.0")
testImplementation("junit:junit:4.13.2")
androidTestImplementation("androidx.test.ext:junit:1.1.5")
androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")
implementation("com.journeyapps:zxing-android-embedded:4.3.0") {
isTransitive = false
}
implementation("com.google.zxing:core:3.3.0")
implementation(project(":tauri-android"))
}

@ -0,0 +1,21 @@
# Add project specific ProGuard rules here.
# You can control the set of applied configuration files using the
# proguardFiles setting in build.gradle.
#
# For more details, see
# http://developer.android.com/guide/developing/tools/proguard.html
# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
# public *;
#}
# Uncomment this to preserve the line number information for
# debugging stack traces.
#-keepattributes SourceFile,LineNumberTable
# If you keep the line number information, uncomment this to
# hide the original source file name.
#-renamesourcefileattribute SourceFile

@ -0,0 +1,2 @@
include ':tauri-android'
project(':tauri-android').projectDir = new File('./.tauri/tauri-api')

@ -0,0 +1,24 @@
package app.tauri.barcodescanner
import androidx.test.platform.app.InstrumentationRegistry
import androidx.test.ext.junit.runners.AndroidJUnit4
import org.junit.Test
import org.junit.runner.RunWith
import org.junit.Assert.*
/**
* Instrumented test, which will execute on an Android device.
*
* See [testing documentation](http://d.android.com/tools/testing).
*/
@RunWith(AndroidJUnit4::class)
class ExampleInstrumentedTest {
@Test
fun useAppContext() {
// Context of the app under test.
val appContext = InstrumentationRegistry.getInstrumentation().targetContext
assertEquals("app.tauri.barcodescanner", appContext.packageName)
}
}

@ -0,0 +1,11 @@
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:hardwareAccelerated="true">
<!-- Paste the following line into the AndroidManifest.xml of your project -->
<!-- See also: https://capacitorjs.com/docs/plugins/android#manifest -->
<!-- <uses-feature android:name="android.hardware.camera" android:required="false" /> -->
<uses-sdk tools:overrideLibrary="com.google.zxing.client.android" />
<uses-permission android:name="android.permission.VIBRATE" />
</manifest>

@ -0,0 +1,412 @@
package app.tauri.barcodescanner
import android.Manifest
import android.annotation.SuppressLint
import android.app.Activity
import android.content.Context
import android.content.Context.MODE_PRIVATE
import android.content.Intent
import android.content.SharedPreferences
import android.content.pm.PackageManager
import android.net.Uri
import android.os.Build
import android.os.VibrationEffect
import android.os.Vibrator
import android.provider.Settings
import android.util.Size
import android.view.ViewGroup
import android.webkit.WebView
import android.widget.FrameLayout
import androidx.activity.result.ActivityResult
import androidx.camera.core.Camera
import androidx.camera.core.CameraSelector
import androidx.camera.core.ImageAnalysis
import androidx.camera.core.ImageProxy
import androidx.camera.core.Preview
import androidx.camera.lifecycle.ProcessCameraProvider
import androidx.camera.view.PreviewView
import androidx.core.content.ContextCompat
import androidx.lifecycle.LifecycleOwner
import app.tauri.Logger
import app.tauri.PermissionState
import app.tauri.annotation.ActivityCallback
import app.tauri.annotation.Command
import app.tauri.annotation.Permission
import app.tauri.annotation.PermissionCallback
import app.tauri.annotation.TauriPlugin
import app.tauri.plugin.Invoke
import app.tauri.plugin.JSArray
import app.tauri.plugin.JSObject
import app.tauri.plugin.Plugin
import com.google.common.util.concurrent.ListenableFuture
import com.google.mlkit.vision.barcode.BarcodeScannerOptions
import com.google.mlkit.vision.barcode.BarcodeScanning
import com.google.mlkit.vision.barcode.common.Barcode
import com.google.mlkit.vision.common.InputImage
import org.json.JSONException
import java.util.Collections
import java.util.concurrent.ExecutionException
private const val PERMISSION_ALIAS_CAMERA = "camera"
private const val PERMISSION_NAME = Manifest.permission.CAMERA
private const val PREFS_PERMISSION_FIRST_TIME_ASKING = "PREFS_PERMISSION_FIRST_TIME_ASKING"
@TauriPlugin(
permissions = [
Permission(strings = [Manifest.permission.CAMERA], alias = "camera")
]
)
class BarcodeScannerPlugin(private val activity: Activity) : Plugin(activity),
ImageAnalysis.Analyzer {
private lateinit var webView: WebView
private var previewView: PreviewView? = null
private var cameraProviderFuture: ListenableFuture<ProcessCameraProvider>? = null
private var cameraProvider: ProcessCameraProvider? = null
private var graphicOverlay: GraphicOverlay? = null
private var camera: Camera? = null
private var vibrator: Vibrator? = null
private var scannerOptions: BarcodeScannerOptions? = null
private var scanner: com.google.mlkit.vision.barcode.BarcodeScanner? = null
private var requestPermissionResponse: JSObject? = null
private var cameraReady = false
// declare a map constant for allowed barcode formats
private val supportedFormats = supportedFormats()
private var savedInvoke: Invoke? = null
override fun load(webView: WebView) {
super.load(webView)
this.webView = webView
}
private fun supportedFormats(): Map<String, Int> {
val map: MutableMap<String, Int> = HashMap()
map["UPC_A"] = Barcode.FORMAT_UPC_A
map["UPC_E"] = Barcode.FORMAT_UPC_E
map["EAN_8"] = Barcode.FORMAT_EAN_8
map["EAN_13"] = Barcode.FORMAT_EAN_13
map["CODE_39"] = Barcode.FORMAT_CODE_39
map["CODE_93"] = Barcode.FORMAT_CODE_93
map["CODE_128"] = Barcode.FORMAT_CODE_128
map["CODABAR"] = Barcode.FORMAT_CODABAR
map["ITF"] = Barcode.FORMAT_ITF
map["AZTEC"] = Barcode.FORMAT_AZTEC
map["DATA_MATRIX"] = Barcode.FORMAT_DATA_MATRIX
map["PDF_417"] = Barcode.FORMAT_PDF417
map["QR_CODE"] = Barcode.FORMAT_QR_CODE
return Collections.unmodifiableMap(map)
}
private fun hasCamera(): Boolean {
return activity.packageManager
.hasSystemFeature(PackageManager.FEATURE_CAMERA_ANY)
}
private fun setupCamera(cameraDirection: String) {
activity
.runOnUiThread {
val previewView = PreviewView(activity)
previewView.layoutParams = FrameLayout.LayoutParams(
ViewGroup.LayoutParams.MATCH_PARENT,
ViewGroup.LayoutParams.MATCH_PARENT
)
this.previewView = previewView
val graphicOverlay = GraphicOverlay(activity)
graphicOverlay.layoutParams = FrameLayout.LayoutParams(
ViewGroup.LayoutParams.MATCH_PARENT,
ViewGroup.LayoutParams.MATCH_PARENT
)
this.graphicOverlay = graphicOverlay
val parent = webView.parent as ViewGroup
parent.addView(previewView)
parent.addView(graphicOverlay)
val cameraProviderFuture = ProcessCameraProvider.getInstance(activity)
cameraProviderFuture.addListener(
{
try {
val cameraProvider = cameraProviderFuture.get()
bindPreview(
cameraProvider,
if (cameraDirection == "front") CameraSelector.LENS_FACING_FRONT else CameraSelector.LENS_FACING_BACK
)
this.cameraProvider = cameraProvider
} catch (e: InterruptedException) {
// ignored
} catch (_: ExecutionException) {
// ignored
}
},
ContextCompat.getMainExecutor(activity)
)
this.cameraProviderFuture = cameraProviderFuture
}
}
private fun bindPreview(cameraProvider: ProcessCameraProvider, cameraDirection: Int) {
activity
.runOnUiThread {
val preview = Preview.Builder().build()
val cameraSelector =
CameraSelector.Builder().requireLensFacing(cameraDirection).build()
preview.setSurfaceProvider(previewView?.surfaceProvider)
val imageAnalysis = ImageAnalysis.Builder()
.setBackpressureStrategy(ImageAnalysis.STRATEGY_KEEP_ONLY_LATEST)
.setTargetResolution(Size(1280, 720))
.build()
imageAnalysis.setAnalyzer(
ContextCompat.getMainExecutor(activity),
this
)
camera = cameraProvider.bindToLifecycle(
activity as LifecycleOwner,
cameraSelector,
preview,
imageAnalysis
)
}
}
private fun dismantleCamera() {
// opposite of setupCamera
activity
.runOnUiThread {
if (cameraProvider != null) {
cameraProvider?.unbindAll()
val parent = webView.parent as ViewGroup
parent.removeView(previewView)
parent.removeView(graphicOverlay)
camera = null
previewView = null
graphicOverlay = null
}
}
}
private fun getFormats(invoke: Invoke): List<Int> {
val jsFormats = invoke.getArray("formats", JSArray())
val formats = ArrayList<Int>()
for (i in 0 until jsFormats.length()) {
try {
val targetedFormat: String = jsFormats.getString(i)
val targetedBarcodeFormat =
supportedFormats[targetedFormat]
if (targetedBarcodeFormat != null) {
formats.add(targetedBarcodeFormat)
}
} catch (e: JSONException) {
e.printStackTrace()
}
}
return formats
}
private fun prepareInternal(direction: String) {
dismantleCamera()
setupCamera(direction)
}
private fun destroy() {
dismantleCamera()
savedInvoke = null
}
@Suppress("DEPRECATION")
private fun configureCamera(formats: List<Int>) {
activity
.runOnUiThread {
val vibrator =
activity.getSystemService(Context.VIBRATOR_SERVICE) as Vibrator
this.vibrator = vibrator
if (previewView == null) {
throw Exception("Something went wrong configuring the BarcodeScanner")
}
if (formats.isNotEmpty()) {
val mappedFormats = mapFormats(formats)
val options =
BarcodeScannerOptions.Builder()
.setBarcodeFormats(Barcode.FORMAT_QR_CODE, *mappedFormats).build()
scannerOptions = options
scanner = BarcodeScanning.getClient(options)
} else {
val options = BarcodeScannerOptions.Builder()
.setBarcodeFormats(Barcode.FORMAT_ALL_FORMATS).build()
scannerOptions = options
scanner = BarcodeScanning.getClient(options)
}
}
}
private fun mapFormats(integers: List<Int>): IntArray {
val ret = IntArray(integers.size)
for (i in ret.indices) {
if (integers[i] != Barcode.FORMAT_QR_CODE) ret[i] = integers[i]
}
return ret
}
override fun analyze(image: ImageProxy) {
@SuppressLint("UnsafeOptInUsageError") val mediaImage = image.image
if (mediaImage != null) {
val inputImage =
InputImage.fromMediaImage(mediaImage, image.imageInfo.rotationDegrees)
scanner
?.process(inputImage)
?.addOnSuccessListener { barcodes ->
for (barcode in barcodes) {
val bounds = barcode.boundingBox
val rawValue = barcode.rawValue ?: ""
// add vibration logic here
val s = bounds?.flattenToString()
val jsObject = JSObject()
jsObject.put("content", rawValue)
jsObject.put("bounds", s)
savedInvoke?.resolve(jsObject)
destroy()
}
}
?.addOnFailureListener { e ->
Logger.error(e.message ?: e.toString())
}
?.addOnCompleteListener {
image.close()
mediaImage.close()
}
}
}
@Command
fun vibrate(invoke: Invoke) {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
vibrator!!.vibrate(
VibrationEffect.createOneShot(
50,
VibrationEffect.DEFAULT_AMPLITUDE
)
)
}
invoke.resolve()
}
@Command
fun prepare(invoke: Invoke) {
prepareInternal(invoke.getString("cameraDirection", "back"))
cameraReady = true
invoke.resolve()
}
@Command
fun cancel(invoke: Invoke) {
savedInvoke?.reject("cancelled")
destroy()
invoke.resolve()
}
@Command
fun scan(invoke: Invoke) {
savedInvoke = invoke
if (hasCamera()) {
if (getPermissionState("camera") != PermissionState.GRANTED) {
throw Exception("No permission to use camera. Did you request it yet?")
} else {
if (!cameraReady) {
prepareInternal(invoke.getString("cameraDirection", "back"))
}
cameraReady = false
configureCamera(getFormats(invoke))
}
}
}
private fun markFirstPermissionRequest() {
val sharedPreference: SharedPreferences =
activity.getSharedPreferences(PREFS_PERMISSION_FIRST_TIME_ASKING, MODE_PRIVATE)
sharedPreference.edit().putBoolean(PERMISSION_NAME, false).apply()
}
private fun firstPermissionRequest(): Boolean {
return activity.getSharedPreferences(PREFS_PERMISSION_FIRST_TIME_ASKING, MODE_PRIVATE)
.getBoolean(PERMISSION_NAME, true)
}
@SuppressLint("ObsoleteSdkInt")
@PermissionCallback
fun cameraPermissionCallback(invoke: Invoke) {
if (requestPermissionResponse == null) {
return
}
val requestPermissionResponse = requestPermissionResponse!!
val granted = getPermissionState(PERMISSION_ALIAS_CAMERA) === PermissionState.GRANTED
if (granted) {
requestPermissionResponse.put(PERMISSION_ALIAS_CAMERA, PermissionState.GRANTED)
} else {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
if (!activity.shouldShowRequestPermissionRationale(PERMISSION_NAME)) {
requestPermissionResponse.put(PERMISSION_ALIAS_CAMERA, PermissionState.DENIED)
}
} else {
requestPermissionResponse.put(PERMISSION_ALIAS_CAMERA, PermissionState.GRANTED)
}
}
invoke.resolve(requestPermissionResponse)
this.requestPermissionResponse = null
}
@SuppressLint("ObsoleteSdkInt")
@Command
override fun requestPermissions(invoke: Invoke) {
val requestPermissionResponse = JSObject()
this.requestPermissionResponse = requestPermissionResponse
if (getPermissionState(PERMISSION_ALIAS_CAMERA) === PermissionState.GRANTED) {
requestPermissionResponse.put(PERMISSION_ALIAS_CAMERA, PermissionState.GRANTED)
} else {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
if (firstPermissionRequest() || activity.shouldShowRequestPermissionRationale(
PERMISSION_NAME
)
) {
markFirstPermissionRequest()
requestPermissionForAlias(
PERMISSION_ALIAS_CAMERA,
invoke,
"cameraPermissionCallback"
)
return
} else {
requestPermissionResponse.put(PERMISSION_ALIAS_CAMERA, PermissionState.DENIED)
}
} else {
requestPermissionResponse.put(PERMISSION_ALIAS_CAMERA, PermissionState.GRANTED)
}
}
invoke.resolve(requestPermissionResponse)
}
@Command
fun openAppSettings(invoke: Invoke) {
val intent = Intent(
Settings.ACTION_APPLICATION_DETAILS_SETTINGS,
Uri.fromParts("package", activity.packageName, null)
)
intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
startActivityForResult(invoke, intent, "openSettingsResult")
}
@ActivityCallback
private fun openSettingsResult(invoke: Invoke, result: ActivityResult) {
invoke.resolve()
}
}

@ -0,0 +1,188 @@
package app.tauri.barcodescanner
import android.content.Context
import android.graphics.Canvas
import android.graphics.Matrix
import android.graphics.Paint
import android.util.AttributeSet
import android.view.View
import com.google.android.gms.common.internal.Preconditions
class GraphicOverlay: View {
private val lock = Any()
private val graphics: MutableList<Graphic> = ArrayList()
private val transformationMatrix = Matrix()
private var imageWidth = 0
private var imageHeight = 0
private var scaleFactor = 1.0f
private var postScaleWidthOffset = 0f
private var postScaleHeightOffset = 0f
private var isImageFlipped = false
private var needUpdateTransformation = true
abstract class Graphic(private val overlay: GraphicOverlay) {
abstract fun draw(canvas: Canvas?)
protected fun drawRect(
canvas: Canvas,
left: Float,
top: Float,
right: Float,
bottom: Float,
paint: Paint?
) {
canvas.drawRect(left, top, right, bottom, paint!!)
}
protected fun drawText(canvas: Canvas, text: String?, x: Float, y: Float, paint: Paint?) {
canvas.drawText(text!!, x, y, paint!!)
}
/** Adjusts the supplied value from the image scale to the view scale. */
fun scale(imagePixel: Float): Float {
return imagePixel * overlay.scaleFactor
}
val applicationContext
get() = overlay.context.applicationContext
fun isImageFlipped(): Boolean {
return overlay.isImageFlipped
}
fun translateX(x: Float): Float {
return if (overlay.isImageFlipped) {
overlay.width - (scale(x) - overlay.postScaleWidthOffset)
} else {
scale(x) - overlay.postScaleWidthOffset
}
}
fun translateY(y: Float): Float {
return scale(y) - overlay.postScaleHeightOffset
}
fun getTransformationMatrix(): Matrix {
return overlay.transformationMatrix
}
fun postInvalidate() {
overlay.postInvalidate()
}
fun updatePaintColorByZValue(
paint: Paint,
canvas: Canvas,
visualizeZ: Boolean,
rescaleZForVisualization: Boolean,
zInImagePixel: Float,
zMin: Float,
zMax: Float
) {
if (!visualizeZ) {
return
}
val zLowerBoundInScreenPixel: Float
val zUpperBoundInScreenPixel: Float
if (rescaleZForVisualization) {
zLowerBoundInScreenPixel = (-0.001f).coerceAtMost(scale(zMin))
zUpperBoundInScreenPixel = 0.001f.coerceAtLeast(scale(zMax))
} else {
val defaultRangeFactor = 1f
zLowerBoundInScreenPixel = -defaultRangeFactor * canvas.width
zUpperBoundInScreenPixel = defaultRangeFactor * canvas.width
}
val zInScreenPixel = scale(zInImagePixel)
if (zInScreenPixel < 0) {
val v = (zInScreenPixel / zLowerBoundInScreenPixel * 255).toInt()
paint.setARGB(0, 0, 255, 0)
} else {
val v = (zInScreenPixel / zUpperBoundInScreenPixel * 255).toInt()
paint.setARGB(0, 0, 255, 0)
}
}
}
constructor(context: Context): super(context)
constructor(context: Context, attrs: AttributeSet): super(context, attrs) {
addOnLayoutChangeListener { _, _, _, _, _, _, _, _, _ ->
needUpdateTransformation = true
}
}
fun clear() {
synchronized(lock) { graphics.clear() }
postInvalidate()
}
fun add(graphic: Graphic) {
synchronized(lock) { graphics.add(graphic) }
}
fun remove(graphic: Graphic) {
synchronized(lock) { graphics.remove(graphic) }
postInvalidate()
}
fun setImageSourceInfo(imageWidth: Int, imageHeight: Int, isFlipped: Boolean) {
Preconditions.checkState(imageWidth > 0, "image width must be positive")
Preconditions.checkState(imageHeight > 0, "image height must be positive")
synchronized(lock) {
this.imageWidth = imageWidth
this.imageHeight = imageHeight
isImageFlipped = isFlipped
needUpdateTransformation = true
}
postInvalidate()
}
fun getImageWidth(): Int {
return imageWidth
}
fun getImageHeight(): Int {
return imageHeight
}
private fun updateTransformationIfNeeded() {
if (!needUpdateTransformation || imageWidth <= 0 || imageHeight <= 0) {
return
}
val viewAspectRatio = width.toFloat() / height
val imageAspectRatio = imageWidth.toFloat() / imageHeight
postScaleWidthOffset = 0f
postScaleHeightOffset = 0f
if (viewAspectRatio > imageAspectRatio) {
// The image needs to be vertically cropped to be displayed in this view.
scaleFactor = width.toFloat() / imageWidth
postScaleHeightOffset = (width.toFloat() / imageAspectRatio - height) / 2
} else {
// The image needs to be horizontally cropped to be displayed in this view.
scaleFactor = height.toFloat() / imageHeight
postScaleWidthOffset = (height.toFloat() * imageAspectRatio - width) / 2
}
transformationMatrix.reset()
transformationMatrix.setScale(scaleFactor, scaleFactor)
transformationMatrix.postTranslate(-postScaleWidthOffset, -postScaleHeightOffset)
if (isImageFlipped) {
transformationMatrix.postScale(-1f, 1f, width / 2f, height / 2f)
}
needUpdateTransformation = false
}
override fun onDraw(canvas: Canvas?) {
super.onDraw(canvas)
synchronized(lock) {
updateTransformationIfNeeded()
for (graphic in graphics) {
graphic.draw(canvas)
}
}
}
}

@ -0,0 +1,17 @@
package app.tauri.barcodescanner
import org.junit.Test
import org.junit.Assert.*
/**
* Example local unit test, which will execute on the development machine (host).
*
* See [testing documentation](http://d.android.com/tools/testing).
*/
class ExampleUnitTest {
@Test
fun addition_isCorrect() {
assertEquals(4, 2 + 2)
}
}

@ -0,0 +1,12 @@
use std::process::exit;
fn main() {
if let Err(error) = tauri_build::mobile::PluginBuilder::new()
.android_path("android")
.ios_path("ios")
.run()
{
println!("{error:#}");
exit(1);
}
}

@ -0,0 +1,59 @@
import { invoke } from '@tauri-apps/api/tauri'
type PermissionState = 'granted' | 'denied'
type Format = 'QR_CODE' | 'UPC_A' | 'UPC_E' | 'EAN_8' | 'EAN_13' | 'CODE_39' | 'CODE_93' | 'CODE_128' | 'CODABAR' | 'ITF' | 'AZTEC' | 'DATA_MATRIX' | 'PDF_417'
interface ScanOptions {
cameraDirection?: 'back' | 'front'
formats?: Format[]
}
interface PrepareOptions {
cameraDirection?: 'back' | 'front'
}
/**
* Prepare the camera before starting scanning.
* This is optional, only use it if you need a small performance improvement when preparing a scan in advance.
* @param options
*/
export async function prepare(options?: PrepareOptions) {
invoke('plugin:barcodeScanner|prepare', { ...options })
}
/**
* Start scanning.
* @param options
*/
export async function scan(options?: ScanOptions) {
invoke('plugin:barcodeScanner|scan', { ...options })
}
/**
* Cancel the current scan process.
*/
export async function cancel() {
invoke('plugin:barcodeScanner|cancel')
}
/**
* Get permission state.
*/
export async function checkPermissions(): Promise<PermissionState> {
return invoke<{ camera: PermissionState }>('plugin:barcodeScanner|check_permissions').then(r => r.camera)
}
/**
* Request permissions to use the camera.
*/
export async function requestPermissions(): Promise<PermissionState> {
return invoke<{ camera: PermissionState }>('plugin:barcodeScanner|request_permissions').then(r => r.camera)
}
/**
* Open application settings. Useful if permission was denied and the user must manually enable it.
*/
export async function openAppSettings() {
invoke('plugin:barcodeScanner|open_app_settings')
}

@ -0,0 +1,10 @@
.DS_Store
/.build
/Packages
/*.xcodeproj
xcuserdata/
DerivedData/
.swiftpm/config/registries.json
.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
.netrc
Package.resolved

@ -0,0 +1,31 @@
// swift-tools-version:5.3
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
let package = Package(
name: "tauri-plugin-barcode-scanner",
platforms: [
.iOS(.v13),
],
products: [
// Products define the executables and libraries a package produces, and make them visible to other packages.
.library(
name: "tauri-plugin-barcode-scanner",
type: .static,
targets: ["tauri-plugin-barcode-scanner"]),
],
dependencies: [
.package(name: "Tauri", path: "../.tauri/tauri-api")
],
targets: [
// Targets are the basic building blocks of a package. A target can define a module or a test suite.
// Targets can depend on other targets in this package, and on products in packages this package depends on.
.target(
name: "tauri-plugin-barcode-scanner",
dependencies: [
.byName(name: "Tauri")
],
path: "Sources")
]
)

@ -0,0 +1,3 @@
# Tauri Plugin Barcode Scanner
A description of this package.

@ -0,0 +1,16 @@
import UIKit
import WebKit
import Tauri
import SwiftRs
class ExamplePlugin: Plugin {
@objc public func ping(_ invoke: Invoke) throws {
let value = invoke.getString("value")
invoke.resolve(["value": value as Any])
}
}
@_cdecl("init_plugin_{{ plugin_name_snake_case }}")
func initPlugin(name: SRString, webview: WKWebView?) {
Tauri.registerPlugin(webview: webview, name: name.toString(), plugin: ExamplePlugin())
}

@ -0,0 +1,8 @@
import XCTest
@testable import ExamplePlugin
final class ExamplePluginTests: XCTestCase {
func testExample() throws {
let plugin = ExamplePlugin()
}
}

@ -0,0 +1,32 @@
{
"name": "tauri-plugin-barcode-scanner-api",
"version": "0.0.0",
"license": "MIT or APACHE-2.0",
"authors": [
"Tauri Programme within The Commons Conservancy"
],
"type": "module",
"browser": "dist-js/index.min.js",
"module": "dist-js/index.mjs",
"types": "dist-js/index.d.ts",
"exports": {
"import": "./dist-js/index.mjs",
"types": "./dist-js/index.d.ts",
"browser": "./dist-js/index.min.js"
},
"scripts": {
"build": "rollup -c"
},
"files": [
"dist-js",
"!dist-js/**/*.map",
"README.md",
"LICENSE"
],
"devDependencies": {
"tslib": "^2.4.1"
},
"dependencies": {
"@tauri-apps/api": "^1.2.0"
}
}

@ -0,0 +1,11 @@
import { readFileSync } from "fs";
import { createConfig } from "../../shared/rollup.config.mjs";
export default createConfig({
input: "guest-js/index.ts",
pkg: JSON.parse(
readFileSync(new URL("./package.json", import.meta.url), "utf8")
),
external: [/^@tauri-apps\/api/],
});

@ -0,0 +1,25 @@
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT
use serde::{ser::Serializer, Serialize};
pub type Result<T> = std::result::Result<T, Error>;
#[derive(Debug, thiserror::Error)]
pub enum Error {
#[error(transparent)]
Io(#[from] std::io::Error),
#[cfg(mobile)]
#[error(transparent)]
PluginInvoke(#[from] tauri::plugin::mobile::PluginInvokeError),
}
impl Serialize for Error {
fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
where
S: Serializer,
{
serializer.serialize_str(self.to_string().as_ref())
}
}

@ -0,0 +1,59 @@
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT
#![cfg(mobile)]
use tauri::{
plugin::{Builder, PluginHandle, TauriPlugin},
Manager, Runtime,
};
pub use models::*;
mod error;
mod models;
pub use error::{Error, Result};
#[cfg(target_os = "android")]
const PLUGIN_IDENTIFIER: &str = "app.tauri.barcodescanner";
#[cfg(target_os = "ios")]
tauri::ios_plugin_binding!(init_plugin_barcode_scanner);
/// Access to the {{ plugin_name }} APIs.
pub struct BarcodeScanner<R: Runtime>(PluginHandle<R>);
impl<R: Runtime> BarcodeScanner<R> {
pub fn ping(&self, payload: PingRequest) -> crate::Result<PingResponse> {
self.0
.run_mobile_plugin("ping", payload)
.map_err(Into::into)
}
}
/// Extensions to [`tauri::App`], [`tauri::AppHandle`] and [`tauri::Window`] to access the barcode scanner APIs.
pub trait BarcodeScannerExt<R: Runtime> {
fn barcode_scanner(&self) -> &BarcodeScanner<R>;
}
impl<R: Runtime, T: Manager<R>> crate::BarcodeScannerExt<R> for T {
fn barcode_scanner(&self) -> &BarcodeScanner<R> {
self.state::<BarcodeScanner<R>>().inner()
}
}
/// Initializes the plugin.
pub fn init<R: Runtime>() -> TauriPlugin<R> {
Builder::new("barcodeScanner")
.setup(|app, api| {
#[cfg(target_os = "android")]
let handle = api.register_android_plugin(PLUGIN_IDENTIFIER, "BarcodeScannerPlugin")?;
#[cfg(target_os = "ios")]
let handle = api.register_ios_plugin(init_plugin_barcode_scanner)?;
app.manage(BarcodeScanner(handle));
Ok(())
})
.build()
}

@ -0,0 +1,3 @@
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT

@ -0,0 +1,17 @@
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT
use serde::{Deserialize, Serialize};
#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct PingRequest {
pub value: Option<String>,
}
#[derive(Debug, Clone, Default, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PingResponse {
pub value: Option<String>,
}

@ -0,0 +1,4 @@
{
"extends": "../../tsconfig.base.json",
"include": ["guest-js/*.ts"]
}

@ -70,6 +70,16 @@ importers:
specifier: ^2.5.0 specifier: ^2.5.0
version: 2.5.0 version: 2.5.0
plugins/barcode-scanner:
dependencies:
'@tauri-apps/api':
specifier: ^1.2.0
version: 1.2.0
devDependencies:
tslib:
specifier: ^2.4.1
version: 2.5.0
plugins/cli: plugins/cli:
dependencies: dependencies:
'@tauri-apps/api': '@tauri-apps/api':

Loading…
Cancel
Save