Moved all pattern matching into xml so they can be localized.

Author: Chris Bellew

Voice Control For Plex/src/main/java/com/atomjack/vcfp/MainActivity.java

@@ -377,7 +377,7 @@ public void importTaskerProject(MenuItem item) {
 			is.close();
 
 			String xmlContents = new String(buffer);
-			xmlContents = xmlContents.replace("%RECOGNITION_REGEX%", VoiceControlForPlexApplication.recognition_regex);
+			xmlContents = xmlContents.replace("%RECOGNITION_REGEX%", getString(R.string.pattern_recognition));
 			buffer = xmlContents.getBytes();
 			Logger.d("directory: %s", Environment.getExternalStorageDirectory());
 

Voice Control For Plex/src/main/java/com/atomjack/vcfp/PlayReceiver.java

@@ -16,7 +16,7 @@ public void onReceive(final Context context, final Intent intent)
 		if(queryText == null && intent.getStringExtra(GoogleSearchApi.KEY_QUERY_TEXT) != null)
 			queryText = intent.getStringExtra(GoogleSearchApi.KEY_QUERY_TEXT);
 
-		if(queryText != null && queryText.matches(VoiceControlForPlexApplication.recognition_regex)) {
+		if(queryText != null && queryText.matches(context.getResources().getString(R.string.pattern_recognition))) {
 			queryText = queryText.toLowerCase();
 			Intent sendIntent = new Intent(context, PlexSearch.class);
 			sendIntent.setAction("com.atomjack.vcfp.intent.ACTION_SEARCH");

Voice Control For Plex/src/main/java/com/atomjack/vcfp/PlexSearch.java

@@ -73,7 +73,7 @@ public int onStartCommand(Intent intent, int flags, int startId) {
 			if (intent.getExtras().getStringArrayList(RecognizerIntent.EXTRA_RESULTS) != null) {
 				ArrayList<String> voiceResults = intent.getExtras().getStringArrayList(RecognizerIntent.EXTRA_RESULTS);
 				for(String q : voiceResults) {
-					if(q.matches(VoiceControlForPlexApplication.recognition_regex)) {
+					if(q.matches(getString(R.string.pattern_recognition))) {
 						queryText = q;
 						break;
 					}
@@ -217,22 +217,22 @@ private void handleVoiceSearch() {
 		Logger.d("Servers: %d", VoiceControlForPlexApplication.getPlexMediaServers().size());
 
 		// Check for a sentence starting with "resume watching"
-		p = Pattern.compile("^resume watching (.*)");
+		p = Pattern.compile(getString(R.string.pattern_resume_watching));
 		matcher = p.matcher(queryText);
 		if(matcher.find()) {
 			resumePlayback = true;
 			// Replace "resume watching" with just "watch" so the pattern matching below works
-			queryText = queryText.replaceAll("^resume watching ", "watch ");
+			queryText = matcher.replaceAll(getString(R.string.pattern_watch));
 		}
 
-		p = Pattern.compile( "watch movie (.*)", Pattern.DOTALL);
+		p = Pattern.compile( getString(R.string.pattern_watch_movie), Pattern.DOTALL);
 		matcher = p.matcher(queryText);
 		if(matcher.find()) {
 			mediaType = "movie";
 			queryTerm = matcher.group(1);
 		}
 		if(mediaType.equals("")) {
-			p = Pattern.compile("watch season ([0-9]+) episode ([0-9]+) of (.*)");
+			p = Pattern.compile(getString(R.string.pattern_watch_season_episode_of_show));
 			matcher = p.matcher(queryText);
 
 			if(matcher.find()) {
@@ -243,7 +243,7 @@ private void handleVoiceSearch() {
 			}
 		}
 		if(mediaType.equals("")) {
-			p = Pattern.compile("watch (.*) season ([0-9]+) episode ([0-9]+)");
+			p = Pattern.compile(getString(R.string.pattern_watch_show_season_episode));
 			matcher = p.matcher(queryText);
 
 			if(matcher.find()) {
@@ -254,7 +254,7 @@ private void handleVoiceSearch() {
 			}
 		}
 		if(mediaType.equals("")) {
-			p = Pattern.compile("watch episode (.*) of (.*)");
+			p = Pattern.compile(getString(R.string.pattern_watch_episode_of_show));
 			matcher = p.matcher(queryText);
 			if(matcher.find()) {
 				mediaType = "show";
@@ -263,7 +263,7 @@ private void handleVoiceSearch() {
 			}
 		}
 		if(mediaType.equals("")) {
-			p = Pattern.compile("watch the next episode of (.*)");
+			p = Pattern.compile(getString(R.string.pattern_watch_next_episode_of_show));
 			matcher = p.matcher(queryText);
 
 			if(matcher.find()) {
@@ -273,7 +273,7 @@ private void handleVoiceSearch() {
 			}
 		}
 		if(mediaType.equals("")) {
-			p = Pattern.compile("watch( the)? latest episode of (.*)");
+			p = Pattern.compile(getString(R.string.pattern_watch_latest_episode_of_show));
 			matcher = p.matcher(queryText);
 
 			if(matcher.find()) {
@@ -283,7 +283,7 @@ private void handleVoiceSearch() {
 			}
 		}
 		if(mediaType.equals("")) {
-			p = Pattern.compile("watch (.*) episode (.*)");
+			p = Pattern.compile(getString(R.string.pattern_watch_show_episode_named));
 			matcher = p.matcher(queryText);
 			if(matcher.find()) {
 				mediaType = "show";
@@ -293,7 +293,7 @@ private void handleVoiceSearch() {
 		}
 		// Lastly, try to find a movie matching whatever comes after "watch"
 		if(mediaType.equals("")) {
-			p = Pattern.compile("watch (.*)");
+			p = Pattern.compile(getString(R.string.pattern_watch2));
 			matcher = p.matcher(queryText);
 
 			if(matcher.find()) {
@@ -302,7 +302,7 @@ private void handleVoiceSearch() {
 			}
 		}
 		if(mediaType.equals("")) {
-			p = Pattern.compile("listen to the album (.*) by (.*)");
+			p = Pattern.compile(getString(R.string.pattern_listen_to_album_by_artist));
 			matcher = p.matcher(queryText);
 			if(matcher.find()) {
 				mediaType = "music";
@@ -311,13 +311,14 @@ private void handleVoiceSearch() {
 			}
 		}
 		if(mediaType.equals("")) {
-			p = Pattern.compile("listen to the album (.*)");
+			p = Pattern.compile(getString(R.string.pattern_listen_to_album));
 			matcher = p.matcher(queryText);
 			if(matcher.find()) {
 				mediaType = "music";
 				album = matcher.group(1);
 			}
 		}
+		/*
 		if(mediaType.equals("")) {
 			p = Pattern.compile("listen to (.*) by (.*)");
 			matcher = p.matcher(queryText);
@@ -327,48 +328,49 @@ private void handleVoiceSearch() {
 				artist = matcher.group(2);
 			}
 		}
+		*/
 		if(mediaType.equals("")) {
-			p = Pattern.compile("pause playback", Pattern.DOTALL);
+			p = Pattern.compile(getString(R.string.pattern_pause_playback), Pattern.DOTALL);
 			matcher = p.matcher(queryText);
 			if (matcher.find()) {
 				Logger.d("pausing playback");
 				pausePlayback();
 				return;
 			}
-			p = Pattern.compile("resume playback", Pattern.DOTALL);
+			p = Pattern.compile(getString(R.string.pattern_resume_playback), Pattern.DOTALL);
 			matcher = p.matcher(queryText);
 			if (matcher.find()) {
 				Logger.d("resuming playback");
 				resumePlayback();
 				return;
 			}
-			p = Pattern.compile("stop playback", Pattern.DOTALL);
+			p = Pattern.compile(getString(R.string.pattern_stop_playback), Pattern.DOTALL);
 			matcher = p.matcher(queryText);
 			if (matcher.find()) {
 				Logger.d("stopping playback");
 				stopPlayback();
 				return;
 			}
-			p = Pattern.compile("(offset|timecode) ([0-9]+|two) (hours?|minutes?|seconds?)(?: ([0-9]+|two) (minutes?|seconds?))?(?: ([0-9]+|two) (seconds?))?", Pattern.DOTALL);
+			p = Pattern.compile(getString(R.string.pattern_offset), Pattern.DOTALL);
 			matcher = p.matcher(queryText);
 			if (matcher.find()) {
-				String groupOne = matcher.group(2) != null && matcher.group(2).equals("two") ? "2" : matcher.group(2);
-				String groupThree = matcher.group(4) != null && matcher.group(4).equals("two") ? "2" : matcher.group(4);
-				String groupFive = matcher.group(6) != null && matcher.group(6).equals("two") ? "2" : matcher.group(6);
+				String groupOne = matcher.group(2) != null && matcher.group(2).matches("two|to") ? "2" : matcher.group(2);
+				String groupThree = matcher.group(4) != null && matcher.group(4).matches("two|to") ? "2" : matcher.group(4);
+				String groupFive = matcher.group(6) != null && matcher.group(6).matches("two|to") ? "2" : matcher.group(6);
 				int hours = 0, minutes = 0, seconds = 0;
-				if(matcher.group(5) != null && matcher.group(5).startsWith("minute"))
+				if(matcher.group(5) != null && matcher.group(5).matches(getString(R.string.pattern_minutes)))
 					minutes = Integer.parseInt(groupThree);
-				else if(matcher.group(3) != null && matcher.group(3).startsWith("minute"))
+				else if(matcher.group(3) != null && matcher.group(3).matches(getString(R.string.pattern_minutes)))
 					minutes = Integer.parseInt(groupOne);
 
-				if(matcher.group(6) != null && matcher.group(6).startsWith("second"))
+				if(matcher.group(7) != null && matcher.group(7).matches(getString(R.string.pattern_seconds)))
 					seconds = Integer.parseInt(groupFive);
-				else if(matcher.group(5) != null && matcher.group(5).startsWith("second"))
+				else if(matcher.group(5) != null && matcher.group(5).matches(getString(R.string.pattern_seconds)))
 					seconds = Integer.parseInt(groupThree);
-				else if(matcher.group(3).startsWith("second"))
+				else if(matcher.group(3).matches(getString(R.string.pattern_seconds)))
 					seconds = Integer.parseInt(groupOne);
 
-				if(matcher.group(3).startsWith("hour"))
+				if(matcher.group(3).matches(getString(R.string.pattern_hours)))
 					hours = Integer.parseInt(groupOne);
 
 				seekTo(hours, minutes, seconds);

Voice Control For Plex/src/main/java/com/atomjack/vcfp/VoiceControlForPlexApplication.java

@@ -27,7 +27,6 @@ public class VoiceControlForPlexApplication
 
 	public final static String INTENT_GDMRECEIVE = "0";
 
-	public final static String recognition_regex = "^(((watch|resume watching|listen to|watch movie) )|((offset|timecode) (.*))|((pause|stop|resume) playback))(.*)(on )?";
 	private static ConcurrentHashMap<String, PlexServer> plexmediaServers = new ConcurrentHashMap<String, PlexServer>();
 
 	public static ConcurrentHashMap<String, PlexServer> getPlexMediaServers() {

Voice Control For Plex/src/main/res/values/patterns.xml

@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+This file contains the regular expressions patterns used for figuring out what action the user wishes to take. When
+adding translations, please to not modify (.*), $1, ([0-9]+), etc.
+-->
+<resources>
+    <!--
+    This pattern is the main pattern that will need to be matched in order for anything to be done. As you can see it is
+    a quite complicated regular expression. Plugging it into https://www.debuggex.com/ should help you figure out how
+    it is constructed.
+    -->
+    <item name="pattern_recognition" type="string">^(((watch|resume watching|listen to|watch movie) (.+))|((offset|timecode) (.+))|((pause|stop|resume) playback))(on (.+))?</item>
+
+    <item name="pattern_resume_watching" type="string">^resume watching (.*)</item>
+    <item name="pattern_watch" type="string">watch $1</item>
+    <item name="pattern_watch_movie" type="string">watch movie (.*)</item>
+    <item name="pattern_watch_season_episode_of_show" type="string">watch season ([0-9]+) episode ([0-9]+) of (.*)</item>
+    <item name="pattern_watch_show_season_episode" type="string">watch (.*) season ([0-9]+) episode ([0-9]+)</item>
+    <item name="pattern_watch_episode_of_show" type="string">watch episode (.*) of (.*)</item>
+    <item name="pattern_watch_next_episode_of_show" type="string">watch the next episode of (.*)</item>
+    <item name="pattern_watch_latest_episode_of_show" type="string">watch( the)? latest episode of (.*)</item>
+    <item name="pattern_watch_show_episode_named" type="string">watch (.*) episode (.*)</item>
+    <item name="pattern_watch2" type="string">watch (.*)</item>
+
+    <!--
+    The following pattern lets the user say "listen to <album> by <artist>" or
+    "listen to the album <album> by <artist>".
+    -->
+    <item name="pattern_listen_to_album_by_artist" type="string">listen to( the album)? (.*) by (.*)</item>
+
+    <item name="pattern_listen_to_album" type="string">listen to the album (.*)</item>
+    <item name="pattern_pause_playback" type="string">pause playback</item>
+    <item name="pattern_resume_playback" type="string">resume playback</item>
+    <item name="pattern_stop_playback" type="string">stop playback</item>
+
+    <!--
+    The following are used in conjunction with the pattern_offset below. These should match the
+    (hours?minutes?seconds?), with the addition of the ^ character (to indicate that in the matching
+    pattern group starts with (hours or minutes or seconds). Unreliable behavior may result if
+    these to not match the corresponding groups in pattern_offset.
+    -->
+    <item name="pattern_hours" type="string">^hours?</item>
+    <item name="pattern_minutes" type="string">^minutes?</item>
+    <item name="pattern_seconds" type="string">^seconds?</item>
+
+    <!--
+    Offset pattern. This lets the user start with with "offset" or "timecode", followed by:
+        any number followed by "hour(s)" or "minute(s)" or "second(s)", and optionally followed by:
+        any number followed by "minute(s)" or "second(s)", and optionally followed by:
+        any number followed by "second(s)"
+    The ([0-9]+|two|to) pattern will most likely only need to be ([0-9]+) for other languages, as in English,
+    the number 2 sounds the same as "to" and "two", so sometimes the Voice Recognition engine will confuse the
+    number 2 with "to" or "two". If your language has numbers that sound exactly like other words that the
+    Voice Recognition will sometimes mis-translate, please contact Chris Bellew as some further changes will need
+    to be made to the code to accommodate this.
+
+    The (hours?|minutes?|seconds?) means hour, with or without an s at the end (singular or plural), and the
+    same for minutes and seconds (the | means "or").
+    -->
+    <item name="pattern_offset" type="string">^(offset|timecode) ([0-9]+|two|to) (hours?|minutes?|seconds?)(?: ([0-9]+|two|to) (minutes?|seconds?))?(?: ([0-9]+|two|to) (seconds?))?</item>
+</resources>

Voice Control For Plex/src/main/res/values/strings.xml

@@ -1,7 +1,6 @@
 <resources>
     <string name="app_name">Voice Control for Plex</string>
     <string name="action_settings">Settings</string>
-    <string name="hello_world">Hello world!</string>
     <string name="ok">OK</string>
     <string name="got_it">Got it</string>
     <string name="stream_video_from_server">Stream video from the server</string>