Fixed bug which was causing AnkiDroid API to not list media on cards.

[ujjol1234]

Purpose / Description

Fixed the bug which was causing AnkiDroid API to not list media on cards. Added a unit test to confirm that media files are listed correctly in the ReviewInfo.

Fixes

• Fixes [BUG] AnkiDroid API no longer lists media on cards #17062

Approach

Reimplemented the filesinStr function which was causing the bug.

How Has This Been Tested?

A unit test testMediaFilesAddedCorrectlyInReviewInfo() has been added in the ContentProviderTest.kt to confirm that the MEDIA_FILES attribute of ReviewInfo gets populated correctly.

Checklist

Please, go through these checks before submitting the PR.

• You have a descriptive commit message with a short title (first line, max 50 chars).
• 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

[welcome]

First PR! 🚀 We sincerely appreciate that you have taken the time to propose a change to AnkiDroid! Please have patience with us as we are all volunteers - we will get to this as soon as possible.

[david-allison]

This doesn't look like upstream code:

https://github.com/ankitects/anki/blob/64ca90934bc26ddf7125913abc9dd9de8cb30c2b/pylib/anki/media.py#L136-L150

[ujjol1234]

@david-allison I have reimplemented the old code for the fileinStr from here:

Anki-Android/AnkiDroid/src/main/java/com/ichi2/libanki/Media.kt

Line 218 in 4d39b5b

fun filesInStr(mid: Long?, string: String, includeRemote: Boolean = false): List<String> {

This logic was able to extract the image file names but it could not extract the AV tags. My guess is that this is because the Card.renderOutput returns AVTags and it is in the form SoundOrVideoTag(filename). To address this, I added some logic in the function to extract the AVTags as well, and it is now working as expected! Could you please review the changes and let me know if you think this implementation is correct? Any feedback or suggestions for improvement would be greatly appreciated.

[david-allison]

We should follow upstream as close as possible in libanki, unless there's a strong reason not to

[ujjol1234]

ok I will try again with the upstream code you provided

[ujjol1234]

Hi @david-allison,
I have attempted to implement the upstream code and although the logic successfully includes image files in the returned media array, the audio files are missing. From my observation, the logic I initially added for extracting audio files ensures they are included in the media array.
Here's the code I used:

fun filesInStr(
        currentCard: Card,
        includeRemote: Boolean = false,
    ): List<String> {
        val l: MutableList<String> = ArrayList()
        val model = currentCard.noteType(col)
        val renderOutput = currentCard.renderOutput(col)
        val string = renderOutput.questionText + renderOutput.answerText

        var strings: MutableList<String?> = ArrayList()


        if (model!!.isCloze && string.contains("{{c")) {
                // Expand clozes if necessary
                strings = expandClozes(string)
        } else {
                strings.add(string)
        }

        for (s in strings) {
            var s = s
            // Handle LaTeX
            @KotlinCleanup("change to .map { }")
            val svg = model.optBoolean("latexsvg", false)
            s = LaTeX.mungeQA(s!!, col, svg)

            // Extract filenames from the strings using regex patterns
            var m: Matcher
            for (p in REGEXPS) {
                val fnameIdx =
                    when (p) {
                        fSoundRegexps -> 2
                        fImgAudioRegExpU -> 2
                        else -> 3
                    }
                m = p.matcher(s)
                while (m.find()) {
                    val fname = m.group(fnameIdx)!!
                    val isLocal = !fRemotePattern.matcher(fname.lowercase(Locale.getDefault())).find()
                    if (isLocal || includeRemote) {
                        l.add(fname)
                    }
                }
            }
        }

        return l
    }

Could you please advise on how you would like to proceed? Should I enhance the upstream logic to account for audio files, or is there another direction you'd suggest?