Merge pull request #13 from SEPIA-Framework/dev

v2.2.1 b1

Author: fquirin

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>net.b07z.sepia.server.core</groupId>
     <artifactId>sepia-core-tools</artifactId>
-    <version>2.2.0</version>
+    <version>2.2.1</version>
     <name>SEPIA Core-Tools</name>
     <description>The Core-Tools repository contains classes and methods that are shared by all SEPIA servers and other tools like the SDK.</description>
     <url>https://github.com/SEPIA-Framework/sepia-core-tools-java</url>
@@ -105,7 +105,7 @@
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-databind</artifactId>
-            <version>2.9.8</version>
+            <version>2.9.9</version>
         </dependency>
         <dependency>
             <groupId>commons-lang</groupId>

src/main/java/net/b07z/sepia/server/core/assistant/CLIENTS.java

@@ -8,6 +8,17 @@
  */
 public class CLIENTS {
 
+	public enum Platform {
+		android,
+		ios,
+		browser,
+		windows,
+		java,
+		python,
+		nodejs,
+		unknown
+	}
+	
 	//this is somewhat identical with ENVIRONMENTS but we keep it anyway ^^
 	final public static String WEB_APP = "web_app";				//e.g. HTML Browser
 	final public static String BROWSER = "browser";				//e.g. HTML Browser (alternative to web app)
@@ -17,20 +28,50 @@ public class CLIENTS {
 	final public static String IOS_BROWSER = "ios_browser";		//e.g. iPhone, iPad safari
 	final public static String WIN_APP = "windows_app";			//e.g. windows app store app for mobile or desktop
 	final public static String JAVA_APP = "java_app";			//e.g. VW TTS Client
+	final public static String PYTHON_APP = "python_app";
+	final public static String NODEJS_APP = "nodejs_app";
 	final public static String CHROME_BROWSER = "chrome_browser";
 	final public static String CHROME_APP = "chrome_app";
 	final public static String SAFARI_BROWSER = "safari_browser";
 	final public static String SAFARI_APP = "safari_app";
 	final public static String WAKEWORD_TOOL = "wakeword_tool";
 
 	/**
-	 * Return basic for of the client, e.g. convert "web_app_v1.0.1" to "web_app". 
+	 * Try to identify the platform by using the client info. NOTE: since a developer can in theory define any client info
+	 * this might not be 100% reliable.
+	 * @param clientInfo - info given by any client
+	 * @return
+	 */
+	public static Platform getPlatform(String clientInfo){
+		clientInfo = clientInfo.toLowerCase();
+		if (clientInfo.matches(".*(^|_)(browser|web|html|chrome|safari|firefox|edge|ie)($|_).*")){
+			return Platform.browser;
+		}else if (clientInfo.matches(".*(^|_)(android)($|_).*")){
+			return Platform.android;
+		}else if (clientInfo.matches(".*(^|_)(ios)($|_).*")){
+			return Platform.ios;
+		}else if (clientInfo.matches(".*(^|_)(windows|win)($|_).*")){
+			return Platform.windows;
+		}else if (clientInfo.matches(".*(^|_)(java)($|_).*")){
+			return Platform.java;
+		}else if (clientInfo.matches(".*(^|_)(python)($|_).*")){
+			return Platform.python;
+		}else if (clientInfo.matches(".*(^|_)(node|nodejs)($|_).*")){
+			return Platform.nodejs;
+		}else{
+			return Platform.unknown;
+		}
+	}
+	
+	/**
+	 * Return basic for of the client, e.g. convert "web_app_v1.0.1" to "web_app".<br>
+	 * NOTE: This will INCLUDE the device ID given by the user (if any) at the start. If you are using this in a service you can compare it to input.deviceId.
 	 * @param clientInfo - info given by any client
 	 */
 	public static String getBaseClient(String clientInfo){
 		return clientInfo.replaceFirst("_v\\d.*?(_|$)", "_").trim().replaceFirst("_$", "").replaceAll("[\\W]", "").trim();
 	}
-	
+		
 	//TODO: I think we need to update/simplify this ... and we should write some tests as well! ;-)
 
 	/**

src/main/java/net/b07z/sepia/server/core/assistant/CMD.java

@@ -14,7 +14,8 @@ public class CMD {
 	final public static String BANKING = "banking";					//parameters:	action (<pay>, <show>, <send>), receiver, number, currency
 	final public static String CAR_WELCOME_UPDATE = "car_welcome_up";	//parameters:	-
 	final public static String CHAT = "chat";							//parameters:	apology, complain, compliment, question, ...
-	final public static String CLIENT_CONTROLS = "client_controls";		//parameters:	client_fun
+	final public static String CLIENT_CONTROLS = "client_controls";			//parameters:	client_fun
+	final public static String PLATFORM_CONTROLS = "platform_controls";		//parameters:	android_fun, ios_fun, browser_fun, device_fun
 	final public static String CONTEXT = "context";					//parameters:	- all of the previous command ... -
 	final public static String CONTROL = "control";					//parameters:	type (lights, heater, ...), action (on, off, set, inc. ... complex?), info (room etc.), number (for temp. etc.)
 	final public static String COUNT = "count";						//parameters:	number, memory (saves numbers said)

src/main/java/net/b07z/sepia/server/core/assistant/PARAMETERS.java

@@ -84,10 +84,14 @@ public class PARAMETERS {
 	final public static String FOOD_CLASS = "food_class";		//italienisch, vegetarisch, vegan
 
 	//RADIO - MUSIC
-	final public static String RADIO_STATION = "radio_station";	//name of a radio station
+	final public static String RADIO_STATION = "radio_station";		//name of a radio station
 	final public static String SONG = "song";						//a song
-	final public static String MUSIC_ARTIST = "artist";			//an artist (music or something else)
-	final public static String MUSIC_GENRE = "genre";				//music genre (other genres too?)
+	final public static String MUSIC_ARTIST = "artist";				//an music artist			- TODO: Note that ARTIST and GENRE don't use the music_ suffix here!
+	final public static String MUSIC_ALBUM = "music_album";			//an album
+	final public static String MUSIC_GENRE = "genre";				//music genre
+	final public static String MUSIC_SERVICE = "music_service";		//service like Spotify or Apple Music
+	final public static String PLAYLIST_NAME = "playlist_name";		//name of a playlist
+	final public static String MEDIA_CONTROLS = "media_controls";	//controls for media players like: next, back, louder, stop, play (might partially overlap with ACTION)
 
 	//SMART DEVICES
 	final public static String SMART_DEVICE = "smart_device";				//any smart device
@@ -109,8 +113,13 @@ public class PARAMETERS {
 	final public static String MESH_NODE_PLUGIN_NAME = "node_plugin_name";	//name of mesh node plugin
 	final public static String MESH_NODE_PLUGIN_DATA = "node_plugin_data";	//data (e.g. as JSON string) for node plugin
 
-	//CLIENT CONTROLS
+	//CLIENT and (CLIENT-)PLATFORM CONTROLS
 	final public static String CLIENT_FUN = "client_fun";		//a function to be executed in client
+	final public static String ANDROID_FUN = "android_fun";		//	" 	"
+	final public static String IOS_FUN = "ios_fun";				//	" 	"
+	final public static String BROWSER_FUN = "browser_fun";		//	" 	"
+	final public static String WINDOWS_FUN = "windows_fun";		//	" 	"
+	final public static String DEVICE_FUN = "device_fun";		//	" 	"
 
 	//------------ control parameters -------------
 
@@ -125,11 +134,11 @@ public class PARAMETERS {
 	final public static String CS_COMMAND = "cs_cmd";			//custom service command, so the target server can map it
 
 	//CONTROL PARAMETERS
-	final public static String SELECTION = "selection";		//control parameter: when a command requires the user to choose one of the results ...(use numbers, maybe names too)
 	final public static String ANSWER_STAGE = "ans_stage";	//control parameter: ...if you want to keep track of dialog_stage in command or want to have the option to skip stages
 	final public static String MEMORY = "memory";				//control parameter: ...if you want to keep track of things that have been said already like a command history
 	final public static String FINAL = "final";					//control parameter: collect parameter names here that are checked, validated and final. Use a list like "[location_start,location_end,time]"
 	final public static String CONFIRMATION = "confirmation";	//control parameter: when a critical command requires a confirmation ...(use: ok, cancel)
+	final public static String SELECTION = "selection";		//control parameter: when a command requires the user to choose one of the results ...(use numbers, maybe names too)
 	final public static String DYNAMIC = "dynamic";				//control parameter: collect parameter names here that are dynamically set during service module to include them in interview build scripts. Use a list like in FINAL
 
 	//Exotic or unique stuff