mirror of
https://github.com/ankidroid/Anki-Android.git
synced 2024-09-20 12:02:16 +02:00
created new class for JS API Constant and extracted api check to function
This commit is contained in:
Mani
Mike Hardy
parent
d097160ff3
commit
f1bcdb55b1
@ -34,66 +34,58 @@ import com.ichi2.anki.UIUtils.showThemedToast
|
||||
import com.ichi2.libanki.Consts.CARD_QUEUE
|
||||
import com.ichi2.libanki.Consts.CARD_TYPE
|
||||
import com.ichi2.libanki.Decks
|
||||
import com.ichi2.utils.HashUtil
|
||||
import com.ichi2.utils.JSONException
|
||||
import com.ichi2.utils.JSONObject
|
||||
import timber.log.Timber
|
||||
import java.util.*
|
||||
|
||||
open class AnkiDroidJsAPI(private val activity: AbstractFlashcardViewer) {
|
||||
|
||||
// JS API ERROR CODE
|
||||
@kotlin.jvm.JvmField
|
||||
var ankiJsErrorCodeDefault: Int = 0
|
||||
@kotlin.jvm.JvmField
|
||||
val ankiJsErrorCodeMarkCard: Int = 1
|
||||
@kotlin.jvm.JvmField
|
||||
val ankiJsErrorCodeFlagCard: Int = 2
|
||||
|
||||
private val context: Context = activity
|
||||
|
||||
// js api developer contact
|
||||
@kotlin.jvm.JvmField
|
||||
var mCardSuppliedDeveloperContact = ""
|
||||
@kotlin.jvm.JvmField
|
||||
var mCardSuppliedApiVersion = ""
|
||||
|
||||
private val sCurrentJsApiVersion = "0.0.1"
|
||||
private val sMinimumJsApiVersion = "0.0.1"
|
||||
|
||||
@kotlin.jvm.JvmField
|
||||
val MARK_CARD = "markCard"
|
||||
@kotlin.jvm.JvmField
|
||||
val TOGGLE_FLAG = "toggleFlag"
|
||||
|
||||
/**
|
||||
Javascript Interface class for calling Java function from AnkiDroid WebView
|
||||
see card.js for available functions
|
||||
*/
|
||||
|
||||
// list of api that can be accessed
|
||||
private val mApiList = arrayOf(TOGGLE_FLAG, MARK_CARD)
|
||||
private val context: Context = activity
|
||||
val jsAPIConstants = AnkiDroidJsAPIConstants()
|
||||
|
||||
// JS api list enable/disable status
|
||||
private val mJsApiListMap = HashUtil.HashMapInit<String, Boolean>(mApiList.size)
|
||||
private var mJsApiListMap = jsAPIConstants.initApiMap()
|
||||
|
||||
// Text to speech
|
||||
private val mTalker = JavaScriptTTS()
|
||||
|
||||
// init or reset api list
|
||||
fun init() {
|
||||
mCardSuppliedApiVersion = ""
|
||||
mCardSuppliedDeveloperContact = ""
|
||||
for (api in mApiList) {
|
||||
mJsApiListMap[api] = false
|
||||
}
|
||||
jsAPIConstants.mCardSuppliedApiVersion = ""
|
||||
jsAPIConstants.mCardSuppliedDeveloperContact = ""
|
||||
mJsApiListMap = jsAPIConstants.initApiMap()
|
||||
}
|
||||
|
||||
// Check if value null
|
||||
protected fun isAnkiApiNull(api: String): Boolean {
|
||||
private fun isAnkiApiNull(api: String): Boolean {
|
||||
return mJsApiListMap[api] == null
|
||||
}
|
||||
|
||||
/**
|
||||
* Before calling js api check it init or not. It requires api name its error code.
|
||||
* If developer contract provided with correct js api version then it returns true
|
||||
*
|
||||
*
|
||||
* @param apiName
|
||||
* @param apiErrorCode
|
||||
*/
|
||||
protected fun isInit(apiName: String, apiErrorCode: Int): Boolean {
|
||||
if (isAnkiApiNull(apiName)) {
|
||||
showDeveloperContact(jsAPIConstants.ankiJsErrorCodeDefault)
|
||||
return false
|
||||
} else if (!getJsApiListMap()?.get(apiName)!!) {
|
||||
// see 02-string.xml
|
||||
showDeveloperContact(apiErrorCode)
|
||||
return false
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
/*
|
||||
* see 02-strings.xml
|
||||
* Show Error code when mark card or flag card unsupported
|
||||
@ -105,7 +97,7 @@ open class AnkiDroidJsAPI(private val activity: AbstractFlashcardViewer) {
|
||||
fun showDeveloperContact(errorCode: Int) {
|
||||
val errorMsg: String = context.getString(R.string.anki_js_error_code, errorCode)
|
||||
val parentLayout: View = activity.findViewById(android.R.id.content)
|
||||
val snackbarMsg: String = context.getString(R.string.api_version_developer_contact, mCardSuppliedDeveloperContact, errorMsg)
|
||||
val snackbarMsg: String = context.getString(R.string.api_version_developer_contact, jsAPIConstants.mCardSuppliedDeveloperContact, errorMsg)
|
||||
val snackbar: Snackbar? = UIUtils.showSnackbar(
|
||||
activity,
|
||||
snackbarMsg,
|
||||
@ -128,7 +120,7 @@ open class AnkiDroidJsAPI(private val activity: AbstractFlashcardViewer) {
|
||||
if (TextUtils.isEmpty(apiDevContact)) {
|
||||
return false
|
||||
}
|
||||
val versionCurrent = Version.valueOf(sCurrentJsApiVersion)
|
||||
val versionCurrent = Version.valueOf(jsAPIConstants.sCurrentJsApiVersion)
|
||||
val versionSupplied = Version.valueOf(apiVer)
|
||||
|
||||
/*
|
||||
@ -141,11 +133,11 @@ open class AnkiDroidJsAPI(private val activity: AbstractFlashcardViewer) {
|
||||
true
|
||||
}
|
||||
versionSupplied.lessThan(versionCurrent) -> {
|
||||
showThemedToast(context, context.getString(R.string.update_js_api_version, mCardSuppliedDeveloperContact), false)
|
||||
versionSupplied.greaterThanOrEqualTo(Version.valueOf(sMinimumJsApiVersion))
|
||||
showThemedToast(context, context.getString(R.string.update_js_api_version, jsAPIConstants.mCardSuppliedDeveloperContact), false)
|
||||
versionSupplied.greaterThanOrEqualTo(Version.valueOf(jsAPIConstants.sMinimumJsApiVersion))
|
||||
}
|
||||
else -> {
|
||||
showThemedToast(context, context.getString(R.string.valid_js_api_version, mCardSuppliedDeveloperContact), false)
|
||||
showThemedToast(context, context.getString(R.string.valid_js_api_version, jsAPIConstants.mCardSuppliedDeveloperContact), false)
|
||||
false
|
||||
}
|
||||
}
|
||||
@ -157,8 +149,8 @@ open class AnkiDroidJsAPI(private val activity: AbstractFlashcardViewer) {
|
||||
|
||||
// if supplied api version match then enable api
|
||||
private fun enableJsApi() {
|
||||
for (api in mApiList) {
|
||||
mJsApiListMap[api] = true
|
||||
for (api in mJsApiListMap) {
|
||||
mJsApiListMap[api.key] = true
|
||||
}
|
||||
}
|
||||
|
||||
@ -172,9 +164,9 @@ open class AnkiDroidJsAPI(private val activity: AbstractFlashcardViewer) {
|
||||
var apiStatusJson = ""
|
||||
try {
|
||||
data = JSONObject(jsonData)
|
||||
mCardSuppliedApiVersion = data.optString("version", "")
|
||||
mCardSuppliedDeveloperContact = data.optString("developer", "")
|
||||
if (requireApiVersion(mCardSuppliedApiVersion, mCardSuppliedDeveloperContact)) {
|
||||
jsAPIConstants.mCardSuppliedApiVersion = data.optString("version", "")
|
||||
jsAPIConstants.mCardSuppliedDeveloperContact = data.optString("developer", "")
|
||||
if (requireApiVersion(jsAPIConstants.mCardSuppliedApiVersion, jsAPIConstants.mCardSuppliedDeveloperContact)) {
|
||||
enableJsApi()
|
||||
}
|
||||
apiStatusJson = JSONObject.fromMap(mJsApiListMap).toString()
|
||||
|
||||
@ -0,0 +1,50 @@
|
||||
/****************************************************************************************
|
||||
* Copyright (c) 2020 Mani infinyte01@gmail.com *
|
||||
* *
|
||||
* *
|
||||
* This program is free software; you can redistribute it and/or modify it under *
|
||||
* the terms of the GNU General Public License as published by the Free Software *
|
||||
* Foundation; either version 3 of the License, or (at your option) any later *
|
||||
* version. *
|
||||
* *
|
||||
* This program is distributed in the hope that it will be useful, but WITHOUT ANY *
|
||||
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A *
|
||||
* PARTICULAR PURPOSE. See the GNU General Public License for more details. *
|
||||
* *
|
||||
* You should have received a copy of the GNU General Public License along with *
|
||||
* this program. If not, see http://www.gnu.org/licenses/>. *
|
||||
* *
|
||||
* *************************************************************************************/
|
||||
|
||||
package com.ichi2.anki
|
||||
|
||||
class AnkiDroidJsAPIConstants {
|
||||
// JS API ERROR CODE
|
||||
@kotlin.jvm.JvmField
|
||||
var ankiJsErrorCodeDefault: Int = 0
|
||||
@kotlin.jvm.JvmField
|
||||
val ankiJsErrorCodeMarkCard: Int = 1
|
||||
@kotlin.jvm.JvmField
|
||||
val ankiJsErrorCodeFlagCard: Int = 2
|
||||
|
||||
// js api developer contact
|
||||
@kotlin.jvm.JvmField
|
||||
var mCardSuppliedDeveloperContact = ""
|
||||
@kotlin.jvm.JvmField
|
||||
var mCardSuppliedApiVersion = ""
|
||||
|
||||
val sCurrentJsApiVersion = "0.0.1"
|
||||
val sMinimumJsApiVersion = "0.0.1"
|
||||
|
||||
@kotlin.jvm.JvmField
|
||||
val MARK_CARD = "markCard"
|
||||
@kotlin.jvm.JvmField
|
||||
val TOGGLE_FLAG = "toggleFlag"
|
||||
|
||||
fun initApiMap(): HashMap<String, Boolean> {
|
||||
val jsApiListMap = HashMap<String, Boolean>()
|
||||
jsApiListMap[MARK_CARD] = false
|
||||
jsApiListMap[TOGGLE_FLAG] = false
|
||||
return jsApiListMap
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user