feat: new system info panel in webui settings (#926)

* frontend * fixed Database.DBx return value * api endpoint * updated swagger * fix openbsd variable dereference * tests * only load information if user is owner * memory improvement for other routes
go-shiori · Jun 8, 2024 · 72aecd2 · 72aecd2
1 parent 650f192
commit 72aecd2
Show file tree

Hide file tree

Showing 18 changed files with 371 additions and 27 deletions.
diff --git a/docs/swagger/docs.go b/docs/swagger/docs.go
@@ -181,6 +181,29 @@ const docTemplate = `{
  }
  }
  },
+ "/api/v1/system/info": {
+ "get": {
+ "description": "Get general system information like Shiori version, database, and OS",
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "system"
+ ],
+ "summary": "Get general system information",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/api_v1.infoResponse"
+ }
+ },
+ "403": {
+ "description": "Only owners can access this endpoint"
+ }
+ }
+ }
+ },
  "/api/v1/tags": {
  "get": {
  "produces": [
@@ -228,6 +251,31 @@ const docTemplate = `{
  }
  },
  "definitions": {
+ "api_v1.infoResponse": {
+ "type": "object",
+ "properties": {
+ "database": {
+ "type": "string"
+ },
+ "os": {
+ "type": "string"
+ },
+ "version": {
+ "type": "object",
+ "properties": {
+ "commit": {
+ "type": "string"
+ },
+ "date": {
+ "type": "string"
+ },
+ "tag": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
  "api_v1.loginRequestPayload": {
  "type": "object",
  "required": [

diff --git a/docs/swagger/swagger.json b/docs/swagger/swagger.json
@@ -170,6 +170,29 @@
  }
  }
  },
+ "/api/v1/system/info": {
+ "get": {
+ "description": "Get general system information like Shiori version, database, and OS",
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "system"
+ ],
+ "summary": "Get general system information",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/api_v1.infoResponse"
+ }
+ },
+ "403": {
+ "description": "Only owners can access this endpoint"
+ }
+ }
+ }
+ },
  "/api/v1/tags": {
  "get": {
  "produces": [
@@ -217,6 +240,31 @@
  }
  },
  "definitions": {
+ "api_v1.infoResponse": {
+ "type": "object",
+ "properties": {
+ "database": {
+ "type": "string"
+ },
+ "os": {
+ "type": "string"
+ },
+ "version": {
+ "type": "object",
+ "properties": {
+ "commit": {
+ "type": "string"
+ },
+ "date": {
+ "type": "string"
+ },
+ "tag": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
  "api_v1.loginRequestPayload": {
  "type": "object",
  "required": [

diff --git a/docs/swagger/swagger.yaml b/docs/swagger/swagger.yaml
@@ -1,4 +1,20 @@
 definitions:
+ api_v1.infoResponse:
+ properties:
+ database:
+ type: string
+ os:
+ type: string
+ version:
+ properties:
+ commit:
+ type: string
+ date:
+ type: string
+ tag:
+ type: string
+ type: object
+ type: object
  api_v1.loginRequestPayload:
  properties:
  password:
@@ -239,6 +255,22 @@ paths:
  summary: Get readable version of bookmark.
  tags:
  - Auth
+ /api/v1/system/info:
+ get:
+ description: Get general system information like Shiori version, database, and
+ OS
+ produces:
+ - application/json
+ responses:
+ "200":
+ description: OK
+ schema:
+ $ref: '#/definitions/api_v1.infoResponse'
+ "403":
+ description: Only owners can access this endpoint
+ summary: Get general system information
+ tags:
+ - system
  /api/v1/tags:
  get:
  produces:

diff --git a/internal/database/database.go b/internal/database/database.go
@@ -65,7 +65,7 @@ func Connect(ctx context.Context, dbURL string) (DB, error) {
 // DB is interface for accessing and manipulating data in database.
 type DB interface {
  // DBx is the underlying sqlx.DB
- DBx() sqlx.DB
+ DBx() *sqlx.DB
 
  // Migrate runs migrations for this database
  Migrate(ctx context.Context) error
@@ -117,7 +117,7 @@ type DB interface {
 }
 
 type dbbase struct {
- sqlx.DB
+ *sqlx.DB
 }
 
 func (db *dbbase) withTx(ctx context.Context, fn func(tx *sqlx.Tx) error) error {

diff --git a/internal/database/mysql.go b/internal/database/mysql.go
@@ -80,12 +80,12 @@ func OpenMySQLDatabase(ctx context.Context, connString string) (mysqlDB *MySQLDa
  db.SetMaxOpenConns(100)
  db.SetConnMaxLifetime(time.Second) // in case mysql client has longer timeout (driver issue #674)
 
- mysqlDB = &MySQLDatabase{dbbase: dbbase{*db}}
+ mysqlDB = &MySQLDatabase{dbbase: dbbase{db}}
  return mysqlDB, err
 }
 
 // DBX returns the underlying sqlx.DB object
-func (db *MySQLDatabase) DBx() sqlx.DB {
+func (db *MySQLDatabase) DBx() *sqlx.DB {
  return db.DB
 }
 

diff --git a/internal/database/pg.go b/internal/database/pg.go
@@ -76,12 +76,12 @@ func OpenPGDatabase(ctx context.Context, connString string) (pgDB *PGDatabase, e
  db.SetMaxOpenConns(100)
  db.SetConnMaxLifetime(time.Second)
 
- pgDB = &PGDatabase{dbbase: dbbase{*db}}
+ pgDB = &PGDatabase{dbbase: dbbase{db}}
  return pgDB, err
 }
 
 // DBX returns the underlying sqlx.DB object
-func (db *PGDatabase) DBx() sqlx.DB {
+func (db *PGDatabase) DBx() *sqlx.DB {
  return db.DB
 }
 

diff --git a/internal/database/sqlite.go b/internal/database/sqlite.go
@@ -80,7 +80,7 @@ type tagContent struct {
 }
 
 // DBX returns the underlying sqlx.DB object
-func (db *SQLiteDatabase) DBx() sqlx.DB {
+func (db *SQLiteDatabase) DBx() *sqlx.DB {
  return db.DB
 }
 

diff --git a/internal/database/sqlite_noncgo.go b/internal/database/sqlite_noncgo.go
@@ -20,6 +20,6 @@ func OpenSQLiteDatabase(ctx context.Context, databasePath string) (sqliteDB *SQL
  return nil, errors.WithStack(err)
  }
 
- sqliteDB = &SQLiteDatabase{dbbase: dbbase{*db}}
+ sqliteDB = &SQLiteDatabase{dbbase: dbbase{db}}
  return sqliteDB, nil
 }
diff --git a/internal/database/sqlite_openbsd.go b/internal/database/sqlite_openbsd.go
@@ -21,6 +21,6 @@ func OpenSQLiteDatabase(ctx context.Context, databasePath string) (sqliteDB *SQL
  return nil, errors.WithStack(err)
  }
 
- sqliteDB = &SQLiteDatabase{dbbase: dbbase{*db}}
+ sqliteDB = &SQLiteDatabase{dbbase: dbbase{db}}
  return sqliteDB, nil
 }
diff --git a/internal/http/routes/api/v1/api.go b/internal/http/routes/api/v1/api.go
@@ -18,6 +18,7 @@ func (r *APIRoutes) Setup(g *gin.RouterGroup) model.Routes {
  r.handle(g, "/auth", NewAuthAPIRoutes(r.logger, r.deps, r.loginHandler))
  r.handle(g, "/bookmarks", NewBookmarksAPIRoutes(r.logger, r.deps))
  r.handle(g, "/tags", NewTagsPIRoutes(r.logger, r.deps))
+ r.handle(g, "/system", NewSystemAPIRoutes(r.logger, r.deps))
 
  return r
 }

diff --git a/internal/http/routes/api/v1/auth.go b/internal/http/routes/api/v1/auth.go
@@ -99,13 +99,11 @@ func (r *AuthAPIRoutes) loginHandler(c *gin.Context) {
  return
  }
 
- responseMessage := loginResponseMessage{
+ response.Send(c, http.StatusOK, loginResponseMessage{
  Token: token,
  SessionID: sessionID,
  Expiration: expiration.Unix(),
- }
-
- response.Send(c, http.StatusOK, responseMessage)
+ })
 }
 
 // refreshHandler godoc
@@ -132,11 +130,9 @@ func (r *AuthAPIRoutes) refreshHandler(c *gin.Context) {
  return
  }
 
- responseMessage := loginResponseMessage{
+ response.Send(c, http.StatusAccepted, loginResponseMessage{
  Token: token,
- }
-
- response.Send(c, http.StatusAccepted, responseMessage)
+ })
 }
 
 // meHandler godoc

diff --git a/internal/http/routes/api/v1/bookmarks.go b/internal/http/routes/api/v1/bookmarks.go
@@ -97,7 +97,7 @@ type readableResponseMessage struct {
 // @Tags Auth
 // @securityDefinitions.apikey ApiKeyAuth
 // @Produce json
-// @Success 200 {object} readableResponseMessage
+// @Success 200 {object} readableResponseMessage
 // @Failure 403 {object} nil "Token not provided/invalid"
 // @Router /api/v1/bookmarks/id/readable [get]
 func (r *BookmarksAPIRoutes) bookmarkReadable(c *gin.Context) {
@@ -107,20 +107,19 @@ func (r *BookmarksAPIRoutes) bookmarkReadable(c *gin.Context) {
  if err != nil {
  return
  }
- responseMessage := readableResponseMessage{
+
+ response.Send(c, 200, readableResponseMessage{
  Content: bookmark.Content,
  Html: bookmark.HTML,
- }
-
- response.Send(c, 200, responseMessage)
+ })
 }
 
 // updateCache godoc
 //
 // @Summary Update Cache and Ebook on server.
 // @Tags Auth
 // @securityDefinitions.apikey ApiKeyAuth
-// @Param payload body updateCachePayload true "Update Cache Payload"`
+// @Param payload body updateCachePayload true "Update Cache Payload"`
 // @Produce json
 // @Success 200 {object} model.BookmarkDTO
 // @Failure 403 {object} nil "Token not provided/invalid"

diff --git a/internal/http/routes/api/v1/system.go b/internal/http/routes/api/v1/system.go
@@ -0,0 +1,74 @@
+package api_v1
+
+import (
+ "net/http"
+ "runtime"
+
+ "github.com/gin-gonic/gin"
+ "github.com/go-shiori/shiori/internal/dependencies"
+ "github.com/go-shiori/shiori/internal/http/context"
+ "github.com/go-shiori/shiori/internal/http/middleware"
+ "github.com/go-shiori/shiori/internal/http/response"
+ "github.com/go-shiori/shiori/internal/model"
+ "github.com/sirupsen/logrus"
+)
+
+type SystemAPIRoutes struct {
+ logger *logrus.Logger
+ deps *dependencies.Dependencies
+}
+
+func (r *SystemAPIRoutes) Setup(g *gin.RouterGroup) model.Routes {
+ g.Use(middleware.AuthenticationRequired())
+ g.GET("/info", r.infoHandler)
+ return r
+}
+
+type infoResponse struct {
+ Version struct {
+ Tag string `json:"tag"`
+ Commit string `json:"commit"`
+ Date string `json:"date"`
+ } `json:"version"`
+ Database string `json:"database"`
+ OS string `json:"os"`
+}
+
+// System info API endpoint godoc
+//
+// @Summary Get general system information
+// @Description Get general system information like Shiori version, database, and OS
+// @Tags system
+// @Produce json
+// @securityDefinitions.apikey ApiKeyAuth
+// @Success 200 {object} infoResponse
+// @Failure 403 {object} nil "Only owners can access this endpoint"
+// @Router /api/v1/system/info [get]
+func (r *SystemAPIRoutes) infoHandler(c *gin.Context) {
+ ctx := context.NewContextFromGin(c)
+ if !ctx.GetAccount().Owner {
+ response.SendError(c, http.StatusForbidden, "Only owners can access this endpoint")
+ return
+ }
+
+ response.Send(c, 200, infoResponse{
+ Version: struct {
+ Tag string `json:"tag"`
+ Commit string `json:"commit"`
+ Date string `json:"date"`
+ }{
+ Tag: model.BuildVersion,
+ Commit: model.BuildCommit,
+ Date: model.BuildDate,
+ },
+ Database: r.deps.Database.DBx().DriverName(),
+ OS: runtime.GOOS + " (" + runtime.GOARCH + ")",
+ })
+}
+
+func NewSystemAPIRoutes(logger *logrus.Logger, deps *dependencies.Dependencies) *SystemAPIRoutes {
+ return &SystemAPIRoutes{
+ logger: logger,
+ deps: deps,
+ }
+}