feat(api/domain): add GET /conf/domain endpoint

ArtalkJS · Feb 11, 2024 · cf20946 · cf20946
1 parent 2cd2165
commit cf20946
Show file tree

Hide file tree

Showing 7 changed files with 216 additions and 22 deletions.
diff --git a/docs/swagger/docs.go b/docs/swagger/docs.go
@@ -787,6 +787,35 @@ const docTemplate = `{
                 }
             }
         },
+        "/conf/domain": {
+            "get": {
+                "description": "Get Domain Info",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "System"
+                ],
+                "summary": "Get Domain Info",
+                "operationId": "GetDomain",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Domain URL",
+                        "name": "url",
+                        "in": "query"
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/handler.ResponseConfDomain"
+                        }
+                    }
+                }
+            }
+        },
         "/notifies": {
             "get": {
                 "description": "Get a list of notifies for user",
@@ -2387,7 +2416,7 @@ const docTemplate = `{
                     "application/json"
                 ],
                 "tags": [
-                    "Account"
+                    "Auth"
                 ],
                 "summary": "Get User Info",
                 "operationId": "GetUser",
@@ -2443,7 +2472,7 @@ const docTemplate = `{
                     "application/json"
                 ],
                 "tags": [
-                    "Account"
+                    "Auth"
                 ],
                 "summary": "Get Access Token",
                 "operationId": "Login",
@@ -2494,8 +2523,8 @@ const docTemplate = `{
                             ]
                         }
                     },
-                    "403": {
-                        "description": "Forbidden",
+                    "401": {
+                        "description": "Unauthorized",
                         "schema": {
                             "allOf": [
                                 {
@@ -2545,7 +2574,7 @@ const docTemplate = `{
                     "application/json"
                 ],
                 "tags": [
-                    "Account"
+                    "Auth"
                 ],
                 "summary": "Get Login Status",
                 "operationId": "GetUserStatus",
@@ -3545,8 +3574,7 @@ const docTemplate = `{
                 "is_pinned",
                 "page_key",
                 "rid",
-                "site_name",
-                "ua"
+                "site_name"
             ],
             "properties": {
                 "content": {
@@ -4184,6 +4212,23 @@ const docTemplate = `{
                 }
             }
         },
+        "handler.ResponseConfDomain": {
+            "type": "object",
+            "required": [
+                "is_trusted",
+                "origin"
+            ],
+            "properties": {
+                "is_trusted": {
+                    "description": "Is the domain trusted",
+                    "type": "boolean"
+                },
+                "origin": {
+                    "description": "The origin of the domain",
+                    "type": "string"
+                }
+            }
+        },
         "handler.ResponseNotifyList": {
             "type": "object",
             "required": [

diff --git a/docs/swagger/swagger.json b/docs/swagger/swagger.json
@@ -780,6 +780,35 @@
                 }
             }
         },
+        "/conf/domain": {
+            "get": {
+                "description": "Get Domain Info",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "System"
+                ],
+                "summary": "Get Domain Info",
+                "operationId": "GetDomain",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Domain URL",
+                        "name": "url",
+                        "in": "query"
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/handler.ResponseConfDomain"
+                        }
+                    }
+                }
+            }
+        },
         "/notifies": {
             "get": {
                 "description": "Get a list of notifies for user",
@@ -2380,7 +2409,7 @@
                     "application/json"
                 ],
                 "tags": [
-                    "Account"
+                    "Auth"
                 ],
                 "summary": "Get User Info",
                 "operationId": "GetUser",
@@ -2436,7 +2465,7 @@
                     "application/json"
                 ],
                 "tags": [
-                    "Account"
+                    "Auth"
                 ],
                 "summary": "Get Access Token",
                 "operationId": "Login",
@@ -2487,8 +2516,8 @@
                             ]
                         }
                     },
-                    "403": {
-                        "description": "Forbidden",
+                    "401": {
+                        "description": "Unauthorized",
                         "schema": {
                             "allOf": [
                                 {
@@ -2538,7 +2567,7 @@
                     "application/json"
                 ],
                 "tags": [
-                    "Account"
+                    "Auth"
                 ],
                 "summary": "Get Login Status",
                 "operationId": "GetUserStatus",
@@ -3538,8 +3567,7 @@
                 "is_pinned",
                 "page_key",
                 "rid",
-                "site_name",
-                "ua"
+                "site_name"
             ],
             "properties": {
                 "content": {
@@ -4177,6 +4205,23 @@
                 }
             }
         },
+        "handler.ResponseConfDomain": {
+            "type": "object",
+            "required": [
+                "is_trusted",
+                "origin"
+            ],
+            "properties": {
+                "is_trusted": {
+                    "description": "Is the domain trusted",
+                    "type": "boolean"
+                },
+                "origin": {
+                    "description": "The origin of the domain",
+                    "type": "string"
+                }
+            }
+        },
         "handler.ResponseNotifyList": {
             "type": "object",
             "required": [

diff --git a/docs/swagger/swagger.yaml b/docs/swagger/swagger.yaml
@@ -345,7 +345,6 @@ definitions:
     - page_key
     - rid
     - site_name
-    - ua
     type: object
   handler.ParamsEmailSend:
     properties:
@@ -764,6 +763,18 @@ definitions:
     - vote_down
     - vote_up
     type: object
+  handler.ResponseConfDomain:
+    properties:
+      is_trusted:
+        description: Is the domain trusted
+        type: boolean
+      origin:
+        description: The origin of the domain
+        type: string
+    required:
+    - is_trusted
+    - origin
+    type: object
   handler.ResponseNotifyList:
     properties:
       count:
@@ -1560,6 +1571,25 @@ paths:
       summary: Get System Configs
       tags:
       - System
+  /conf/domain:
+    get:
+      description: Get Domain Info
+      operationId: GetDomain
+      parameters:
+      - description: Domain URL
+        in: query
+        name: url
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/handler.ResponseConfDomain'
+      summary: Get Domain Info
+      tags:
+      - System
   /notifies:
     get:
       consumes:
@@ -2511,7 +2541,7 @@ paths:
       - ApiKeyAuth: []
       summary: Get User Info
       tags:
-      - Account
+      - Auth
   /user/access_token:
     post:
       consumes:
@@ -2548,8 +2578,8 @@ paths:
                 msg:
                   type: string
               type: object
-        "403":
-          description: Forbidden
+        "401":
+          description: Unauthorized
           schema:
             allOf:
             - $ref: '#/definitions/handler.Map'
@@ -2568,7 +2598,7 @@ paths:
               type: object
       summary: Get Access Token
       tags:
-      - Account
+      - Auth
   /user/status:
     get:
       description: Get user login status by header Authorization
@@ -2593,7 +2623,7 @@ paths:
       - ApiKeyAuth: []
       summary: Get Login Status
       tags:
-      - Account
+      - Auth
   /users:
     post:
       consumes:

diff --git a/server/handler/conf_domain.go b/server/handler/conf_domain.go
@@ -0,0 +1,42 @@
+package handler
+
+import (
+	"net/url"
+
+	"github.com/ArtalkJS/Artalk/internal/core"
+	"github.com/ArtalkJS/Artalk/server/common"
+	"github.com/ArtalkJS/Artalk/server/middleware"
+	"github.com/gofiber/fiber/v2"
+)
+
+type ResponseConfDomain struct {
+	Origin    string `json:"origin"`     // The origin of the domain
+	IsTrusted bool   `json:"is_trusted"` // Is the domain trusted
+}
+
+// @Id            GetDomain
+// @Summary       Get Domain Info
+// @Description   Get Domain Info
+// @Tags          System
+// @Produce       json
+// @Param         url query string false "Domain URL"
+// @Success       200  {object}  ResponseConfDomain
+// @Router        /conf/domain  [get]
+func ConfDomain(app *core.App, router fiber.Router) {
+	router.Get("/conf/domain", func(c *fiber.Ctx) error {
+		domainURL := c.Query("url")
+		if domainURL == "" {
+			domainURL = c.Get("Origin")
+		}
+		u, err := url.Parse(domainURL)
+		if err != nil {
+			return common.RespError(c, 400, "Invalid URL")
+		}
+		origin := u.Scheme + "://" + u.Host
+		isTrusted := middleware.CheckOriginTrusted(app, origin)
+		return common.RespData(c, ResponseConfDomain{
+			IsTrusted: isTrusted,
+			Origin:    origin,
+		})
+	})
+}
diff --git a/server/middleware/cors.go b/server/middleware/cors.go
@@ -36,14 +36,14 @@ func getCorsAllowOrigins(app *core.App) []string {
 	return allowOrigins
 }
 
-func isOriginAllowed(app *core.App, origin string) bool {
+func CheckOriginTrusted(app *core.App, origin string) bool {
 	return slices.Contains(getCorsAllowOrigins(app), origin)
 }
 
 func CorsMiddleware(app *core.App) func(*fiber.Ctx) error {
 	return cors.New(cors.Config{
 		AllowOriginsFunc: func(origin string) bool {
-			return isOriginAllowed(app, origin)
+			return CheckOriginTrusted(app, origin)
 		},
 	})
 }
diff --git a/server/server.go b/server/server.go
@@ -90,6 +90,7 @@ func Serve(app *core.App) (*fiber.App, error) {
 
 		h.Conf(app, api)
 		h.Version(app, api)
+		h.ConfDomain(app, api)
 
 		// captcha
 		h.Captcha(app, api)