Revize 34bf7aa2

Refs #8620, #8619. Refactor + testing.

Server/ServerApp/DataDownload/DataDownloader.cs

@@ -1 @@
-using System;
+//
+// Author: Eliska Mourycova
+//
+
+using System;
 using System.Collections.Generic;
 using System.IO;
 using System.IO.Compression;
-using System.Linq;
 using System.Net;
-using System.Text;
-using System.Text.RegularExpressions;
-using System.Threading.Tasks;
-using static System.Net.Mime.MediaTypeNames;
 
 namespace DataDownload
 {
+	/// <summary>
+	/// Enum representing all of the available data types (not all will be used in this project)
+	/// They are in Czech for easier handling file names.
+	/// TBD: They might be translated to English later.
+	/// </summary>
 	public enum DataType
 	{
 		POCASI, ENERGO, STROJE, EMAIL, OBSAZENI_MISTNOSTI, JIS, KOLOBEZKY, WIFI
 	}
+
+	/// <summary>
+	/// Represent all available data formats.
+	/// </summary>
 	public enum DataFormat
 	{
 		XML, JSON, CSV
 	}
 
+	/// <summary>
+	/// This class takes care of downloading of data. Download happens from http://openstore.zcu.cz/.
+	/// </summary>
 	public class DataDownloader
 	{
+		/// <summary>
+		/// The root directory containing all downloaded data
+		/// </summary>
 		public string DataDirectory { get; }
+
+		/// <summary>
+		/// Flag stating whether files which already exist should be overwritten when downloaded again
+		/// </summary>
 		public bool OverwriteExisting { get; set; }
 
+		// the main site where the data can be downloaded from
 		private string site;
+
+		// the substring at the start of every file name
 		private string dataStr;
+
+		// WebClient instance used for the actual download
 		private WebClient webClient;
+
+		// a shortcut to writing Path.DirectorySeparatorChar
 		private char sep = Path.DirectorySeparatorChar;
 
 		public DataDownloader()
 		{
+			// initialize all needed variables:
+
 			Console.WriteLine(Directory.GetCurrentDirectory());
 			site = "http://openstore.zcu.cz/";
 			dataStr = "OD_ZCU_";
@@ -42 +69 @@
 			webClient = new WebClient();
 		}
 
+		/// <summary>
+		/// Downloads a specific archive.
+		/// </summary>
+		/// <param name="type">The type of data</param>
+		/// <param name="format">The format of the data</param>
+		/// <param name="year">The year</param>
+		/// <param name="month">The month</param>
+		/// <returns>A list of all extracted file names (should be only one)</returns>
 		private List<string> DownloadData(DataType type, DataFormat format, int year, int month)
 		{
 			// the list of all files potentially relevant to the caller