Revize 9cc42e60

Re #9055. Fixed admin commands related bug + refactor + documentation comments

Server/ServerApp/Connection/ConnectionListener.cs

@@ -154 +154 @@
 			logger.Debug("At the end of HandleRequest");
 		}
 
-
+		/// <summary>
+		/// The callnack method triggered when client request received
+		/// </summary>
+		/// <param name="result"></param>
 		private void ListenerCallback(IAsyncResult result)
 		{
 			logger.Debug("in ListenerCallback");
@@ -239 +242 @@
 
 		}
 
-
+		/// <summary>
+		/// Constructs the response for GET requests
+		/// </summary>
+		/// <param name="requestString">The whole string received with the GET request</param>
+		/// <returns>The response string, empty if client's request doesn't follow protocol</returns>
 		private string ConstructGETResponse(string requestString)
 		{
 			//Console.WriteLine("Constructiing a response for GET request.");
@@ -291 +298 @@
 
 		}
 
+		/// <summary>
+		/// Constructs the response for POST requests
+		/// </summary>
+		/// <param name="requestString">The whole string received with the POST request</param>
+		/// <returns>The response string, empty if client's request doesn't follow protocol</returns>
 		private string ConstructPOSTResponse(string requestString)
 		{
 			logger.Info("Constructing a response for POST request.");
@@ -333 +345 @@
 
 		}
 
-
+		/// <summary>
+		/// Gets the IPv4 IP of the machine
+		/// </summary>
+		/// <returns>The IP as a string</returns>
 		private string GetLocalIPAddress()
 		{
 			var host = Dns.GetHostEntry(Dns.GetHostName());

Server/ServerApp/Program.cs

@@ -16 +16 @@
 namespace ServerApp
 {
 
-	class Config // TBD where this should go
+	class Config
 	{
 		public string DataWebsite { get; set; }
 		public string DownloadedFilesNaming { get; set; }
@@ -28 +28 @@
     public class Program
     {
 
-		//public void NotifyUserMessage(string message)
-		//{
-		//	Console.WriteLine("Received user message: " + message);
-		//}
-
         static void Main(string[] args)
         {
             // setup logging service
@@ -42 +37 @@
 			Config config = FillConfigInfo(args);
 			if (config == null)
 			{
+				Console.WriteLine("Configuration file parsing failed. Abort.");
 				Console.ReadLine();
 				return;
 			}
@@ -49 +45 @@
 			// data download test
 			DataDownloader dd = DataDownloadAndRetrievalTest(config);
 
-			WeatherAsStringTest(dd);
-			Console.ReadLine();
+			//WeatherAsStringTest(dd);
+			//Console.ReadLine();
 
 			// xml building test
 			//XMLTest();
@@ -73 +69 @@
 			Thread inputThread = new Thread(ca.AcceptCommand);
 			inputThread.Start();
 
+
 			// connection test
 			ConnectionTest(controller, config);
 
-			Console.ReadLine();
+			//Console.ReadLine();
         }
 
 
@@ -202 +199 @@
 			Console.WriteLine("Parsing configuration file...");
 			
 			if (args.Length != 1)
-				Console.WriteLine("Wrong usage of parameters, pass the path to a config file."); // todo better explanation?
+				Console.WriteLine("Wrong usage of parameters, pass only the path to a config file.");
 
 			string fullPathConfig = Path.GetFullPath(args[0]);
 			string[] lines = null;
@@ -248 +245 @@
 				}
 			}
 
+			int parsedPort;
+
+			bool success = int.TryParse(extractedConfigInfo.Port, out parsedPort);
+			if (!success)
+			{
+				Console.WriteLine("Configured port " + extractedConfigInfo.Port + " is not an integer number! Abort.");
+				return null;
+			}
+				
+
 			return extractedConfigInfo;
 		}
     }

Server/ServerApp/Properties/launchSettings.json

@@ -2 +2 @@
   "profiles": {
     "ServerApp": {
       "commandName": "Project",
-      "commandLineArgs": ".\\server_config"
+      "commandLineArgs": "C:\\Users\\elisk\\Documents\\aswi2021tri-musketyri\\Server\\ServerApp\\server_config"
     }
   }
 }

Server/ServerApp/User/Command.cs

@@ -1 @@
-using System;
+//
+// Author: Eliska Mourycova
+//
+
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
@@ -6 +10 @@
 
 namespace ServerApp.User
 {
-
+	/// <summary>
+	/// This class represents a command input by the admin
+	/// </summary>
 	public class Command
 	{
+		/// <summary>
+		/// The whole string input
+		/// </summary>
 		public string WholeCommand { get; set; }
+
+		/// <summary>
+		/// The main part of the command
+		/// </summary>
 		public string MainCommand { get; set; }
+
+		/// <summary>
+		/// The flags and data associated with the command
+		/// </summary>
 		public Dictionary<string, List<string>> FlagsAndData { get; }
+
+		// the last flag used
 		private string lastFlag;
 
 		public Command()
@@ -21 +40 @@
 			lastFlag = "";
 		}
 
+		/// <summary>
+		/// Adds a flag to the dictionary
+		/// </summary>
+		/// <param name="flag">The flag to add</param>
 		public void AddFlag(string flag)
 		{
 			FlagsAndData.Add(flag, new List<string>());
 			lastFlag = flag;
 		}
 
+		/// <summary>
+		/// Adds data after a flag
+		/// </summary>
+		/// <param name="data">The data to add</param>
 		public void AddData(string data)
 		{
-			FlagsAndData[lastFlag].Add(data);
+			if(FlagsAndData.ContainsKey(lastFlag))
+				FlagsAndData[lastFlag].Add(data);
 		}
 	}
 }

Server/ServerApp/User/CommandsAcceptor.cs

@@ -13 +13 @@
 namespace ServerApp.User
 {
 	
-
+	/// <summary>
+	/// This class tkes care of parsing and executing admin commands
+	/// </summary>
 	public class CommandsAcceptor
 	{
+		// the DataDownloader instance
 		private DataDownloader dd;
+
+		// the predictor instance
 		private IPredictionController model;
 
 		public CommandsAcceptor(DataDownloader dd, IPredictionController controller)
@@ -25 +30 @@
 			this.model = controller;
 		}
 
+		/// <summary>
+		/// Prints a prompt and waits for input
+		/// </summary>
 		public void AcceptCommand()
 		{
 			while (true) {
@@ -35 +43 @@
 					Console.WriteLine("received admin command: " + command);
 					Command c = ParseString(command);
 					CheckCommand(c);
-					//Program.NotifyUserMessage(command);
 				}
 
 			}
 		}
 
+		/// <summary>
+		/// Parses the input string
+		/// </summary>
+		/// <param name="str">The whole string typed in by the user</param>
+		/// <returns>A new instance of the Command class</returns>
 		private Command ParseString(string str)
 		{
 
@@ -67 +79 @@
 			return command;
 		}
 
+		/// <summary>
+		/// Checks the comamnd and decides what to do according to the main command
+		/// </summary>
+		/// <param name="c">The command</param>
 		private void CheckCommand(Command c)
 		{
 
@@ -87 +103 @@
 			}
 		}
 
+		/// <summary>
+		/// Prints to the console, that the given command is unknown
+		/// </summary>
+		/// <param name="command">The input command</param>
 		private void PrintUnknown(string command)
 		{
 			Console.WriteLine("Unknown command: " + command);
 		}
 
+		/// <summary>
+		/// Handles the command linked to data listing and downloading
+		/// </summary>
+		/// <param name="c">The command</param>
 		private void HandleDataCommand(Command c)
 		{
 			// data -list
@@ -151 +175 @@
 				
 				
 			}
+			else
+			{
+				PrintUnknown(c.WholeCommand);
+				HandleHelpCommand(c);
+			}
 		}
 
+		/// <summary>
+		/// Handles the command linked to predictor training, rollback and files listing
+		/// </summary>
+		/// <param name="c">The command</param>
 		private void HandleModelCommand(Command c)
 		{
 			// TODO:
@@ -193 +226 @@
 						break;
 				}
 			}
+			else
+			{
+				PrintUnknown(c.WholeCommand);
+				HandleHelpCommand(c);
+			}
 
 
 			//model.Rollback() // 0 -ok, 1 nejde, 2 - error (kdyz nekdo smaze soubor config)
 			//model.GetDataFileNames();
 		}
 
+		/// <summary>
+		/// Prints help to the console
+		/// </summary>
+		/// <param name="c"></param>
 		private void HandleHelpCommand(Command c)
 		{
 			Console.WriteLine("List of available commands and their description: ");
@@ -223 +265 @@
 			Console.WriteLine("      Example: model -rollback");
 		}
 
-		private void PrintUsage(Command c)
-		{
-			
-		}
 	}
 }