JS API to open card browser and search with query

[krmanik]

Pull Request template

Purpose / Description

This is continuation of JS API features. From reviewer using js function/button in one click it will go to CardBrowser and search for cards using query.

Fixes

Fixes #8109

Approach

1. Added a JSInterface function and used intent to call CardBrowser
2. Get string extra in CardBrowser and assign query to mSearchTerms then call searchCards()

How Has This Been Tested?

Testesd on devices and emulator

1. Add a button in card template to call AnkiDroidJS.ankiSearchCard(query)
2. Add query like, this query are same as entering in CardBrowser

'deck:"deck name" {{front}}'
'deck:"test" flag:2 tag:marked'
'deck:"test" flag:2 tag:marked is:suspended'
'deck:"test" flag:2 tag:marked search text here'

3. Click button to run the query

<button onclick="AnkiDroidJS.ankiSearchCard('deck:\"test\" {{hanzi}}')">Search this in Card browser</button>

video

Note in this video: Add AnkiDroidJS. before ankiSearchCard because JSInterface used to call this function.

video.mp4

Another example, Added following to front side of card template

<button onclick="searchCard();">{{Simplified}}</button>     //  <-----  note this line

<script>
function searchCard() {
AnkiDroidJS.ankiSearchCard('deck:"xiehanzi HSK 3.0" {{Simplified}}');  //  <-----  note this line
}
</script>

<div class="text-color1">{{Pinyin}}</div>
<div class="text-color3">{{Meaning}}</div>

image

Learning (optional, can help others)

https://github.com/ankidroid/Anki-Android/wiki/AnkiDroid-Javascript-API

Checklist

Please, go through these checks before submitting the PR.

• You have not changed whitespace unnecessarily (it makes diffs hard to read)
• You have a descriptive commit message with a short title (first line, max 50 chars).
• Your code follows the style of the project (e.g. never omit braces in if statements)
• You have commented your code, particularly in hard-to-understand areas
• You have performed a self-review of your own code
• UI changes: include screenshots of all affected screens (in particular showing any new or changed strings)
• UI Changes: You have tested your change using the Google Accessibility Scanner

[mikehardy]

I like this idea, but as mentioned in comments, split into 2 commits where one alters the API and all callers to always use Nullable query string to open card browser as a small simple change, then second commit layers the new Javascript API on top of it using the new capability

[krmanik]

I like this idea, but as mentioned in comments, split into 2 commits where one alters the API and all callers to always use Nullable query string to open card browser as a small simple change, then second commit layers the new Javascript API on top of it using the new capability

I will split into two PR. Thanks

[mikehardy]

For this one could just be 2 commits I think - in this same PR, that would work for me, these ones will be small

[krmanik]

For this one could just be 2 commits I think - in this same PR, that would work for me, these ones will be small

Okay, I will do it.

[mikehardy]

Can you use @JavascriptInterface in this one as well? Like in #9245 ?

[mikehardy]

Nice!

[mikehardy]

Has a conflict with your other PR though 😅

[krmanik]

Yes, I think I need to rebase it.

I also thinking about implementing in signal. Because here are two types of function

• Functions that get parameter(s) - ankiShowToast, ankiMarkCard etc.
• Functions that do not get parameter(s) - All JSInterface functions

So, should we make a rule that function that needs parameter(s) should go through signal and the function which do no require parameter(s) should go though JSInterface?

As security concerns discussed in PR comments #9245

[mikehardy]

• I am not aware of any security concerns for JavascriptInterface anymore (android 5+). Arguments, no arguments, no matter.
• I am under the impression everything should be JavascriptInterface, I expect this to be JavascriptInterface
• The commit history here is not good. There is no reason to have more than one commit here, containing nothing but the commit that adds the JavascriptInterface. Rebase is what you need to get there

[krmanik]

Okay, I am on it.

[mikehardy]

Nice!