feat: result returns source and target lang. #64

main.go

@@ -2,7 +2,7 @@
  * @Author: Vincent Young
  * @Date: 2023-07-01 21:45:34
  * @LastEditors: Vincent Young
- * @LastEditTime: 2023-07-03 00:50:36
+ * @LastEditTime: 2023-09-14 13:34:42
  * @FilePath: /DeepLX/main.go
  * @Telegram: https://t.me/missuo
  *
@@ -122,49 +122,58 @@ type ResData struct {
 }
 
 func main() {
-	// parse flags
+	// Parsing the command-line flags
 	flag.Parse()
 
-	// display information
+	// Displaying initialization information
 	fmt.Printf("DeepL X has been successfully launched! Listening on 0.0.0.0:%v\n", port)
-	fmt.Println("Made by sjlleo and missuo.")
+	fmt.Println("Developed by sjlleo <i@leo.moe> and missuo <me@missuo.me>.")
 
-	// create a random id
+	// Generating a random ID
 	id := getRandomNumber()
 
-	// set release mode
+	// Setting the application to release mode
 	gin.SetMode(gin.ReleaseMode)
 	r := gin.Default()
 	r.Use(cors.Default())
 
+	// Defining the root endpoint which returns the project details
 	r.GET("/", func(c *gin.Context) {
 		c.JSON(200, gin.H{
 			"code":    200,
-			"message": "DeepL Free API, Made by sjlleo and missuo. Go to /translate with POST. http://github.com/OwO-Network/DeepLX",
+			"message": "DeepL Free API, Developed by sjlleo <i@leo.moe> and missuo <me@missuo.me>. Go to /translate with POST. http://github.com/OwO-Network/DeepLX",
 		})
 	})
 
+	// Defining the translation endpoint which receives translation requests and returns translations
 	r.POST("/translate", func(c *gin.Context) {
 		reqj := ResData{}
 		c.BindJSON(&reqj)
 
+		// Extracting details from the request JSON
 		sourceLang := reqj.SourceLang
 		targetLang := reqj.TargetLang
 		translateText := reqj.TransText
+
+		// If source language is not specified, auto-detect it
 		if sourceLang == "" {
 			lang := whatlanggo.DetectLang(translateText)
 			deepLLang := strings.ToUpper(lang.Iso6391())
 			sourceLang = deepLLang
 		}
+		// If target language is not specified, set it to English
 		if targetLang == "" {
 			targetLang = "EN"
 		}
+		// Handling empty translation text
 		if translateText == "" {
 			c.JSON(http.StatusNotFound, gin.H{
 				"code":    http.StatusNotFound,
 				"message": "No Translate Text Found",
 			})
-		} else {
+			return
+		}
+		// Preparing the request data for the DeepL API
 		url := "https://www2.deepl.com/jsonrpc"
 		id = id + 1
 		postData := initData(sourceLang, targetLang)
@@ -172,22 +181,22 @@ func main() {
 			Text:                translateText,
 			RequestAlternatives: 3,
 		}
-			// set id
 		postData.ID = id
-			// set text
 		postData.Params.Texts = append(postData.Params.Texts, text)
-			// set timestamp
 		postData.Params.Timestamp = getTimeStamp(getICount(translateText))
+
+		// Marshalling the request data to JSON and making necessary string replacements
 		post_byte, _ := json.Marshal(postData)
 		postStr := string(post_byte)
 
-			// add space if necessary
+		// Adding spaces to the JSON string based on the ID to adhere to DeepL's request formatting rules
 		if (id+5)%29 == 0 || (id+3)%13 == 0 {
 			postStr = strings.Replace(postStr, "\"method\":\"", "\"method\" : \"", -1)
 		} else {
 			postStr = strings.Replace(postStr, "\"method\":\"", "\"method\": \"", -1)
 		}
 
+		// Creating a new HTTP POST request with the JSON data as the body
 		post_byte = []byte(postStr)
 		reader := bytes.NewReader(post_byte)
 		request, err := http.NewRequest("POST", url, reader)
@@ -196,7 +205,7 @@ func main() {
 			return
 		}
 
-			// Set Headers
+		// Setting HTTP headers to mimic a request from the DeepL iOS App
 		request.Header.Set("Content-Type", "application/json")
 		request.Header.Set("Accept", "*/*")
 		request.Header.Set("x-app-os-name", "iOS")
@@ -209,6 +218,7 @@ func main() {
 		request.Header.Set("x-app-version", "2.9.1")
 		request.Header.Set("Connection", "keep-alive")
 
+		// Making the HTTP request to the DeepL API
 		client := &http.Client{}
 		resp, err := client.Do(request)
 		if err != nil {
@@ -217,6 +227,7 @@ func main() {
 		}
 		defer resp.Body.Close()
 
+		// Handling potential Brotli compressed response body
 		var bodyReader io.Reader
 		switch resp.Header.Get("Content-Encoding") {
 		case "br":
@@ -225,13 +236,12 @@ func main() {
 			bodyReader = resp.Body
 		}
 
+		// Reading the response body and parsing it with gjson
 		body, err := io.ReadAll(bodyReader)
-
 		// body, _ := io.ReadAll(resp.Body)
 		res := gjson.ParseBytes(body)
 
-			// display response
+		// Handling various response statuses and potential errors
-			// fmt.Println(res)
 		if res.Get("error.code").String() == "-32600" {
 			log.Println(res.Get("error").String())
 			c.JSON(http.StatusNotAcceptable, gin.H{
@@ -257,17 +267,25 @@ func main() {
 				"id":           id,
 				"data":         res.Get("result.texts.0.text").String(),
 				"alternatives": alternatives,
+				"source_lang":  sourceLang,
+				"target_lang":  targetLang,
 			})
 		}
-		}
 	})
 
+	// Catch-all route to handle undefined paths
+	r.NoRoute(func(c *gin.Context) {
+		c.JSON(http.StatusNotFound, gin.H{
+			"code":    http.StatusNotFound,
+			"message": "Path not found",
+		})
+	})
+
+	// Determining which port to run the server on, with a fallback to a default port
 	envPort, ok := os.LookupEnv("PORT")
 	if ok {
 		r.Run(":" + envPort)
 	} else {
-		// by default, listen and serve on 0.0.0.0:1188
 		r.Run(fmt.Sprintf(":%v", port))
 	}
-
 }