Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added regex support #142

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions app/src/main/java/com/pilot51/voicenotify/Constants.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package com.pilot51.voicenotify

object Constants {
const val REGEX_PREFIX = "\$regex:"
}
9 changes: 7 additions & 2 deletions app/src/main/java/com/pilot51/voicenotify/NotificationInfo.kt
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,13 @@ data class NotificationInfo(
val ttsTextReplace = if (isComposePreview) null else settings.ttsTextReplace
val textReplaceList = PreferencesViewModel.convertTextReplaceStringToList(ttsTextReplace)
for (pair in textReplaceList) {
ttsMessage = ttsMessage!!.replace(
"(?i)${Pattern.quote(pair.first)}".toRegex(), pair.second)
val pattern =
if (pair.first.startsWith(Constants.REGEX_PREFIX))
Regex(pair.first.removePrefix(Constants.REGEX_PREFIX))
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This crashes when a notification is received if the regex is malformed. It should catch PatternSyntaxException as you did for require/ignore and I would suggest falling back to Pattern.quote. I would also suggest, in all 3 options, validating the regex and showing an error (toast is fine) if it's malformed before allowing the user to save it.

I think we want (?i) or RegexOption.IGNORE_CASE here for consistency with the standard string and ignore/require regex, and since the description says it's case insensitive. Alternatively, update the description to indicate that the regex is case sensitive.

else
"(?i)${Pattern.quote(pair.first)}".toRegex()

ttsMessage = ttsMessage!!.replace(pattern, pair.second)
}
val maxLength = if (isComposePreview) 0 else {
settings.ttsMaxLength ?: DEFAULT_MAX_LENGTH
Expand Down
18 changes: 16 additions & 2 deletions app/src/main/java/com/pilot51/voicenotify/Service.kt
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ import kotlinx.coroutines.flow.first
import kotlinx.coroutines.flow.firstOrNull
import kotlinx.coroutines.launch
import java.util.*
import java.util.regex.PatternSyntaxException

class Service : NotificationListenerService() {
private val appContext by ::applicationContext
Expand Down Expand Up @@ -222,16 +223,29 @@ class Service : NotificationListenerService() {
info.ignoreReasons.add(IgnoreReason.EMPTY_MSG)
}
if (ttsMsg != null) {
fun containsOrMatchesRegex(it: String): Boolean {
return if (it.startsWith(Constants.REGEX_PREFIX))
try {
val pattern = it.removePrefix(Constants.REGEX_PREFIX)
Regex(pattern, RegexOption.IGNORE_CASE)
.containsMatchIn(ttsMsg)
} catch (e: PatternSyntaxException) {
false
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

e.printStackTrace() would be a good idea in case someone runs into problems and needs to debug it.

}
else
ttsMsg.contains(it, true)
}

val requireStrings = settings.requireStrings?.split("\n")
val stringRequired = requireStrings?.all {
it.isNotEmpty() && !ttsMsg.contains(it, true)
it.isNotEmpty() && !containsOrMatchesRegex(it)
} ?: false
if (stringRequired) {
info.ignoreReasons.add(IgnoreReason.STRING_REQUIRED)
}
val ignoreStrings = settings.ignoreStrings?.split("\n")
val stringIgnored = ignoreStrings?.any {
it.isNotEmpty() && ttsMsg.contains(it, true)
it.isNotEmpty() && containsOrMatchesRegex(it)
} ?: false
if (stringIgnored) {
info.ignoreReasons.add(IgnoreReason.STRING_IGNORED)
Expand Down