mirrors/nginx-ui
1
0
Fork 0
mirror of https://github.com/0xJacky/nginx-ui.git synced 2025-05-10 18:05:48 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

refactor: cache index

Browse source
This commit is contained in:
Jacky 2025-04-04 02:00:18 +00:00
parent 5d8d96fd4f
commit 269397e114
No known key found for this signature in database
GPG key ID: 215C21B10DF38B4D
20 changed files with 532 additions and 364 deletions
Download patch file Download diff file Expand all files Collapse all files

8
api/index/router.go Normal file
View file

@ -0,0 +1,8 @@
package index
import "github.com/gin-gonic/gin"
// InitRouter registers all the index related routes
func InitRouter(r *gin.RouterGroup) {
r.GET("index/status", GetIndexStatus)
}

50
api/index/sse.go Normal file
View file

@ -0,0 +1,50 @@
package index
import (
"io"
"time"
"github.com/0xJacky/Nginx-UI/api"
"github.com/0xJacky/Nginx-UI/internal/cache"
"github.com/gin-gonic/gin"
)
// GetIndexStatus is an SSE endpoint that sends real-time index status updates
func GetIndexStatus(c *gin.Context) {
api.SetSSEHeaders(c)
notify := c.Writer.CloseNotify()
// Subscribe to scanner status changes
statusChan := cache.SubscribeScanningStatus()
// Ensure we unsubscribe when the handler exits
defer cache.UnsubscribeScanningStatus(statusChan)
// Main event loop
for {
select {
case status, ok := <-statusChan:
// If channel closed, exit
if !ok {
return
}
// Send status update
c.Stream(func(w io.Writer) bool {
c.SSEvent("message", gin.H{
"scanning": status,
})
return false
})
case <-time.After(30 * time.Second):
// Send heartbeat to keep connection alive
c.Stream(func(w io.Writer) bool {
c.SSEvent("heartbeat", "")
return false
})
case <-notify:
// Client disconnected
return
}
}
}

29
api/nginx_log/nginx_log.go
View file

@ -6,7 +6,6 @@ import (
"os"
"strings"
"github.com/0xJacky/Nginx-UI/internal/cache"
"github.com/0xJacky/Nginx-UI/internal/nginx_log"
"github.com/gin-gonic/gin"
"github.com/pkg/errors"
@ -16,20 +15,24 @@ import (
)
const (
// PageSize defines the size of log chunks returned by the API
PageSize = 128 * 1024
)
// controlStruct represents the request parameters for getting log content
type controlStruct struct {
Type string `json:"type"`
LogPath string `json:"log_path"`
Type string `json:"type"` // Type of log: "access" or "error"
LogPath string `json:"log_path"` // Path to the log file
}
// nginxLogPageResp represents the response format for log content
type nginxLogPageResp struct {
Content string `json:"content"`
Page int64 `json:"page"`
Error string `json:"error,omitempty"`
Content string `json:"content"` // Log content
Page int64 `json:"page"` // Current page number
Error string `json:"error,omitempty"` // Error message if any
}
// GetNginxLogPage handles retrieving a page of log content from a log file
func GetNginxLogPage(c *gin.Context) {
page := cast.ToInt64(c.Query("page"))
if page < 0 {
@ -84,6 +87,7 @@ func GetNginxLogPage(c *gin.Context) {
logger.Error(err)
return
}
defer f.Close()
totalPage := logFileStat.Size() / PageSize
@ -100,7 +104,7 @@ func GetNginxLogPage(c *gin.Context) {
buf = make([]byte, PageSize)
offset = (page - 1) * PageSize
// seek
// seek to the correct position in the file
_, err = f.Seek(offset, io.SeekStart)
if err != nil && err != io.EOF {
c.JSON(http.StatusInternalServerError, nginxLogPageResp{
@ -125,28 +129,29 @@ func GetNginxLogPage(c *gin.Context) {
})
}
// GetLogList returns a list of Nginx log files
func GetLogList(c *gin.Context) {
filters := []func(*cache.NginxLogCache) bool{}
filters := []func(*nginx_log.NginxLogCache) bool{}
if c.Query("type") != "" {
filters = append(filters, func(entry *cache.NginxLogCache) bool {
filters = append(filters, func(entry *nginx_log.NginxLogCache) bool {
return entry.Type == c.Query("type")
})
}
if c.Query("name") != "" {
filters = append(filters, func(entry *cache.NginxLogCache) bool {
filters = append(filters, func(entry *nginx_log.NginxLogCache) bool {
return strings.Contains(entry.Name, c.Query("name"))
})
}
if c.Query("path") != "" {
filters = append(filters, func(entry *cache.NginxLogCache) bool {
filters = append(filters, func(entry *nginx_log.NginxLogCache) bool {
return strings.Contains(entry.Path, c.Query("path"))
})
}
data := cache.GetAllLogPaths(filters...)
data := nginx_log.GetAllLogs(filters...)
orderBy := c.DefaultQuery("sort_by", "name")
sort := c.DefaultQuery("order", "desc")

2
api/nginx_log/router.go
View file

@ -2,8 +2,8 @@ package nginx_log
import "github.com/gin-gonic/gin"
// InitRouter registers all the nginx log related routes
func InitRouter(r *gin.RouterGroup) {
r.GET("nginx_log", Log)
r.GET("nginx_logs", GetLogList)
r.GET("nginx_logs/index_status", GetNginxLogsLive)
}

4
api/nginx_log/sse.go
View file

@ -15,10 +15,10 @@ func GetNginxLogsLive(c *gin.Context) {
notify := c.Writer.CloseNotify()
// Subscribe to scanner status changes
statusChan := cache.SubscribeStatusChanges()
statusChan := cache.SubscribeScanningStatus()
// Ensure we unsubscribe when the handler exits
defer cache.UnsubscribeStatusChanges(statusChan)
defer cache.UnsubscribeScanningStatus(statusChan)
// Main event loop
for {

5
api/nginx_log/websocket.go
View file

@ -16,6 +16,8 @@ import (
"github.com/uozi-tech/cosy/logger"
)
// getLogPath resolves the log file path based on the provided control parameters
// It checks if the path is under the whitelist directories
func getLogPath(control *controlStruct) (logPath string, err error) {
// If direct log path is provided, use it
if control.LogPath != "" {
@ -58,6 +60,7 @@ func getLogPath(control *controlStruct) (logPath string, err error) {
return
}
// tailNginxLog tails the specified log file and sends each line to the websocket
func tailNginxLog(ws *websocket.Conn, controlChan chan controlStruct, errChan chan error) {
defer func() {
if err := recover(); err != nil {
@ -130,6 +133,7 @@ func tailNginxLog(ws *websocket.Conn, controlChan chan controlStruct, errChan ch
}
}
// handleLogControl processes websocket control messages
func handleLogControl(ws *websocket.Conn, controlChan chan controlStruct, errChan chan error) {
defer func() {
if err := recover(); err != nil {
@ -160,6 +164,7 @@ func handleLogControl(ws *websocket.Conn, controlChan chan controlStruct, errCha
}
}
// Log handles websocket connection for real-time log viewing
func Log(c *gin.Context) {
var upGrader = websocket.Upgrader{
CheckOrigin: func(r *http.Request) bool {

17
app/src/api/cache_index.ts Normal file
View file

@ -0,0 +1,17 @@
import { useUserStore } from '@/pinia'
import { SSE } from 'sse.js'
const cache_index = {
index_status() {
const { token } = useUserStore()
const url = `/api/index/status`
return new SSE(url, {
headers: {
Authorization: token,
},
})
},
}
export default cache_index

13
app/src/api/nginx_log.ts
View file

@ -1,6 +1,4 @@
import http from '@/lib/http'
import { useUserStore } from '@/pinia'
import { SSE } from 'sse.js'
export interface INginxLogData {
type: string
@ -19,17 +17,6 @@ const nginx_log = {
}) {
return http.get(`/nginx_logs`, { params })
},
logs_live() {
const { token } = useUserStore()
const url = `/api/nginx_logs/index_status`
return new SSE(url, {
headers: {
Authorization: token,
},
})
},
}
export default nginx_log

56
app/src/components/Notification/notifications.ts
View file

@ -4,34 +4,6 @@
const notifications: Record<string, { title: () => string, content: (args: any) => string }> = {
// cert module notifications
'Sync Certificate Error': {
title: () => $gettext('Sync Certificate Error'),
content: (args: any) => $gettext('Sync Certificate %{cert_name} to %{env_name} failed', args),
},
'Sync Certificate Success': {
title: () => $gettext('Sync Certificate Success'),
content: (args: any) => $gettext('Sync Certificate %{cert_name} to %{env_name} successfully', args),
},
// config module notifications
'Sync Config Error': {
title: () => $gettext('Sync Config Error'),
content: (args: any) => $gettext('Sync config %{config_name} to %{env_name} failed', args),
},
'Sync Config Success': {
title: () => $gettext('Sync Config Success'),
content: (args: any) => $gettext('Sync config %{config_name} to %{env_name} successfully', args),
},
'Rename Remote Config Error': {
title: () => $gettext('Rename Remote Config Error'),
content: (args: any) => $gettext('Rename %{orig_path} to %{new_path} on %{env_name} failed', args),
},
'Rename Remote Config Success': {
title: () => $gettext('Rename Remote Config Success'),
content: (args: any) => $gettext('Rename %{orig_path} to %{new_path} on %{env_name} successfully', args),
},
// site module notifications
'Delete Remote Site Error': {
title: () => $gettext('Delete Remote Site Error'),
@ -121,6 +93,34 @@ const notifications: Record<string, { title: () => string, content: (args: any)
title: () => $gettext('All Recovery Codes Have Been Used'),
content: (args: any) => $gettext('Please generate new recovery codes in the preferences immediately to prevent lockout.', args),
},
// cert module notifications
'Sync Certificate Error': {
title: () => $gettext('Sync Certificate Error'),
content: (args: any) => $gettext('Sync Certificate %{cert_name} to %{env_name} failed', args),
},
'Sync Certificate Success': {
title: () => $gettext('Sync Certificate Success'),
content: (args: any) => $gettext('Sync Certificate %{cert_name} to %{env_name} successfully', args),
},
// config module notifications
'Sync Config Error': {
title: () => $gettext('Sync Config Error'),
content: (args: any) => $gettext('Sync config %{config_name} to %{env_name} failed', args),
},
'Sync Config Success': {
title: () => $gettext('Sync Config Success'),
content: (args: any) => $gettext('Sync config %{config_name} to %{env_name} successfully', args),
},
'Rename Remote Config Error': {
title: () => $gettext('Rename Remote Config Error'),
content: (args: any) => $gettext('Rename %{orig_path} to %{new_path} on %{env_name} failed', args),
},
'Rename Remote Config Success': {
title: () => $gettext('Rename Remote Config Success'),
content: (args: any) => $gettext('Rename %{orig_path} to %{new_path} on %{env_name} successfully', args),
},
}
export default notifications

14
app/src/routes/modules/system.ts
View file

@ -18,13 +18,6 @@ export const systemRoutes: RouteRecordRaw[] = [
meta: {
name: () => $gettext('Self Check'),
},
}, {
path: 'about',
name: 'About',
component: () => import('@/views/system/About.vue'),
meta: {
name: () => $gettext('About'),
},
}, {
path: 'backup',
name: 'Backup',
@ -44,6 +37,13 @@ export const systemRoutes: RouteRecordRaw[] = [
return settings.is_remote
},
},
}, {
path: 'about',
name: 'About',
component: () => import('@/views/system/About.vue'),
meta: {
name: () => $gettext('About'),
},
}],
},
]

5
app/src/views/nginx_log/NginxLogList.vue
View file

@ -2,6 +2,7 @@
import type { CustomRender } from '@/components/StdDesign/StdDataDisplay/StdTableTransformer'
import type { Column } from '@/components/StdDesign/types'
import type { SSE, SSEvent } from 'sse.js'
import cacheIndex from '@/api/cache_index'
import nginxLog from '@/api/nginx_log'
import StdCurd from '@/components/StdDesign/StdDataDisplay/StdCurd.vue'
import { input, select } from '@/components/StdDesign/StdDataEntry'
@ -64,12 +65,12 @@ function viewLog(record: { type: string, path: string }) {
}
// Connect to SSE endpoint and setup handlers
function setupSSE() {
async function setupSSE() {
if (sse.value) {
sse.value.close()
}
sse.value = nginxLog.logs_live()
sse.value = cacheIndex.index_status()
// Handle incoming messages
if (sse.value) {

2
go.mod
View file

@ -23,7 +23,6 @@ require (
github.com/golang-jwt/jwt/v5 v5.2.2
github.com/google/uuid v1.6.0
github.com/gorilla/websocket v1.5.3
github.com/hpcloud/tail v1.0.0
github.com/jpillora/overseer v1.1.6
github.com/lib/pq v1.10.9
github.com/minio/selfupdate v0.6.0
@ -268,7 +267,6 @@ require (
google.golang.org/genproto/googleapis/rpc v0.0.0-20250324211829-b45e905df463 // indirect
google.golang.org/grpc v1.71.0 // indirect
google.golang.org/protobuf v1.36.6 // indirect
gopkg.in/fsnotify.v1 v1.4.7 // indirect
gopkg.in/inf.v0 v0.9.1 // indirect
gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect
gopkg.in/ns1/ns1-go.v2 v2.13.0 // indirect

22
go.sum
View file

@ -782,7 +782,6 @@ github.com/cenkalti/backoff/v4 v4.3.0/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyY
github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
github.com/census-instrumentation/opencensus-proto v0.3.0/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
github.com/census-instrumentation/opencensus-proto v0.4.1/go.mod h1:4T9NM4+4Vw91VeyqjLS6ao50K5bOcLKN6Q42XnYaRYw=
github.com/cespare/xxhash v1.1.0 h1:a6HrQnmkObjyL+Gs60czilIUGqrzKutQD6XZog3p+ko=
github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc=
github.com/cespare/xxhash/v2 v2.1.1/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
github.com/cespare/xxhash/v2 v2.1.2/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
@ -902,8 +901,6 @@ github.com/fsnotify/fsnotify v1.5.1/go.mod h1:T3375wBYaZdLLcVNkcVbzGHY7f1l/uK5T5
github.com/fsnotify/fsnotify v1.6.0/go.mod h1:sl3t1tCWJFWoRz9R8WJCbQihKKwmorjAbSClcnxKAGw=
github.com/fsnotify/fsnotify v1.8.0 h1:dAwr6QBTBZIkG8roQaJjGof0pp0EeF+tNV7YBP3F/8M=
github.com/fsnotify/fsnotify v1.8.0/go.mod h1:8jBTzvmWwFyi3Pb8djgCCO5IBqzKJ/Jwo8TRcHyHii0=
github.com/fxamacker/cbor/v2 v2.7.0 h1:iM5WgngdRBanHcxugY4JySA0nk1wZorNOpTgCMedv5E=
github.com/fxamacker/cbor/v2 v2.7.0/go.mod h1:pxXPTn3joSm21Gbwsv0w9OSA2y1HFR9qXEeXQVeNoDQ=
github.com/fxamacker/cbor/v2 v2.8.0 h1:fFtUGXUzXPHTIUdne5+zzMPTfffl3RD5qYnkY40vtxU=
github.com/fxamacker/cbor/v2 v2.8.0/go.mod h1:vM4b+DJCtHn+zz7h3FFp/hDAI9WNWCsZj23V5ytsSxQ=
github.com/gabriel-vasile/mimetype v1.4.8 h1:FfZ3gj38NjllZIeJAmMhr+qKL8Wu+nOoI3GqacKw1NM=
@ -981,12 +978,8 @@ github.com/go-task/slim-sprig/v3 v3.0.0 h1:sUs3vkvUymDpBKi3qH1YSqBQk9+9D/8M2mN1v
github.com/go-task/slim-sprig/v3 v3.0.0/go.mod h1:W848ghGpv3Qj3dhTPRyJypKRiqCdHZiAzKg9hl15HA8=
github.com/go-viper/mapstructure/v2 v2.2.1 h1:ZAaOCxANMuZx5RCeg0mBdEZk7DZasvvZIxtHqx8aGss=
github.com/go-viper/mapstructure/v2 v2.2.1/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
github.com/go-webauthn/webauthn v0.12.2 h1:yLaNPgBUEXDQtWnOjhsGhMMCEWbXwjg/aNkC8riJQI8=
github.com/go-webauthn/webauthn v0.12.2/go.mod h1:Q8SZPPj4sZ469fNTcQXxRpzJOdb30jQrn/36FX8jilA=
github.com/go-webauthn/webauthn v0.12.3 h1:hHQl1xkUuabUU9uS+ISNCMLs9z50p9mDUZI/FmkayNE=
github.com/go-webauthn/webauthn v0.12.3/go.mod h1:4JRe8Z3W7HIw8NGEWn2fnUwecoDzkkeach/NnvhkqGY=
github.com/go-webauthn/x v0.1.19 h1:IUfdHiBRoTdujpBA/14qbrMXQ3LGzYe/PRGWdZcmudg=
github.com/go-webauthn/x v0.1.19/go.mod h1:C5arLuTQ3pVHKPw89v7CDGnqAZSZJj+4Jnr40dsn7tk=
github.com/go-webauthn/x v0.1.20 h1:brEBDqfiPtNNCdS/peu8gARtq8fIPsHz0VzpPjGvgiw=
github.com/go-webauthn/x v0.1.20/go.mod h1:n/gAc8ssZJGATM0qThE+W+vfgXiMedsWi3wf/C4lld0=
github.com/go-zookeeper/zk v1.0.2/go.mod h1:nOB03cncLtlp4t+UAkGSV+9beXP/akpekBwL+UX1Qcw=
@ -1221,7 +1214,6 @@ github.com/hashicorp/memberlist v0.5.0/go.mod h1:yvyXLpo0QaGE59Y7hDTsTzDD25JYBZ4
github.com/hashicorp/serf v0.8.2/go.mod h1:6hOLApaqBFA1NXqRQAsxw9QxuDEvNxSQRwA/JwenrHc=
github.com/hashicorp/serf v0.9.5/go.mod h1:UWDWwZeL5cuWDJdl0C6wrvrUwEqtQ4ZKBKKENpqIUyk=
github.com/hashicorp/serf v0.10.1/go.mod h1:yL2t6BqATOLGc5HF7qbFkTfXoPIY0WZdWHfEvMqbG+4=
github.com/hpcloud/tail v1.0.0 h1:nfCOvKYfkgYP8hkirhJocXT2+zOD8yUNjXaWfTlyFKI=
github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
github.com/huaweicloud/huaweicloud-sdk-go-v3 v0.1.142 h1:9iOJ8tfNLw8uSiR5yx7VcHEYSOajJq5hb9SXF0BCUdA=
github.com/huaweicloud/huaweicloud-sdk-go-v3 v0.1.142/go.mod h1:Y/+YLCFCJtS29i2MbYPTUlNNfwXvkzEsZKR0imY/2aY=
@ -1662,8 +1654,6 @@ github.com/selectel/domains-go v1.1.0 h1:futG50J43ALLKQAnZk9H9yOtLGnSUh7c5hSvuC5
github.com/selectel/domains-go v1.1.0/go.mod h1:SugRKfq4sTpnOHquslCpzda72wV8u0cMBHx0C0l+bzA=
github.com/selectel/go-selvpcclient/v3 v3.2.1 h1:ny6WIAMiHzKxOgOEnwcWE79wIQij1AHHylzPA41MXCw=
github.com/selectel/go-selvpcclient/v3 v3.2.1/go.mod h1:3EfSf8aEWyhspOGbvZ6mvnFg7JN5uckxNyBFPGWsXNQ=
github.com/shirou/gopsutil/v4 v4.25.2 h1:NMscG3l2CqtWFS86kj3vP7soOczqrQYIEhO/pMvvQkk=
github.com/shirou/gopsutil/v4 v4.25.2/go.mod h1:34gBYJzyqCDT11b6bMHP0XCvWeU3J61XRT7a2EmCRTA=
github.com/shirou/gopsutil/v4 v4.25.3 h1:SeA68lsu8gLggyMbmCn8cmp97V1TI9ld9sVzAUcKcKE=
github.com/shirou/gopsutil/v4 v4.25.3/go.mod h1:xbuxyoZj+UsgnZrENu3lQivsngRR5BdjbJwf2fv4szA=
github.com/shopspring/decimal v0.0.0-20180709203117-cd690d0c9e24/go.mod h1:M+9NzErvs504Cn4c5DxATwIqPbtswREoFCre64PpcG4=
@ -1755,13 +1745,8 @@ github.com/subosito/gotenv v1.2.0/go.mod h1:N0PQaV/YGNqwC0u51sEeR/aUtSLEXKX9iv69
github.com/subosito/gotenv v1.4.2/go.mod h1:ayKnFf/c6rvx/2iiLrJUk1e6plDbT3edrFNGqEflhK0=
github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8=
github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU=
github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.1128/go.mod h1:r5r4xbfxSaeR04b166HGsBa/R4U3SueirEUpXGuw+Q0=
github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.1133 h1:S+ZHcAfI8+ii4MfsCr41R3CdhlTsc5OddGsCfeYJdl8=
github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.1133/go.mod h1:r5r4xbfxSaeR04b166HGsBa/R4U3SueirEUpXGuw+Q0=
github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.1134 h1:NDCzSm7r8OZeWQje1FJNHM73Ku4QRrCP1GymfgZYLSM=
github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.1134/go.mod h1:r5r4xbfxSaeR04b166HGsBa/R4U3SueirEUpXGuw+Q0=
github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/dnspod v1.0.1128 h1:mrJ5Fbkd7sZIJ5F6oRfh5zebPQaudPH9Y0+GUmFytYU=
github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/dnspod v1.0.1128/go.mod h1:zbsYIBT+VTX4z4ocjTAdLBIWyNYj3z0BRqd0iPdnjsk=
github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/dnspod v1.0.1134 h1:Iel1hDW0eQt6p8YDRH2EbjiK5mqC4KEzabSKV0ZQ6FY=
github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/dnspod v1.0.1134/go.mod h1:8R/Xhu0hKGRFT30uwoN44bisb3cOoNjV8iwH65DjqUc=
github.com/tjfoc/gmsm v1.4.1 h1:aMe1GlZb+0bLjn+cKTPEvvn9oUEBlJitaZiiBwsbgho=
@ -1786,8 +1771,6 @@ github.com/ugorji/go/codec v1.2.12 h1:9LC83zGrHhuUA9l16C9AHXAqEV/2wBQ4nkvumAE65E
github.com/ugorji/go/codec v1.2.12/go.mod h1:UNopzCgEMSXjBc6AOMqYvWC1ktqTAfzJZUZgYf6w6lg=
github.com/ultradns/ultradns-go-sdk v1.8.0-20241010134910-243eeec h1:2s/ghQ8wKE+UzD/hf3P4Gd1j0JI9ncbxv+nsypPoUYI=
github.com/ultradns/ultradns-go-sdk v1.8.0-20241010134910-243eeec/go.mod h1:BZr7Qs3ku1ckpqed8tCRSqTlp8NAeZfAVpfx4OzXMss=
github.com/uozi-tech/cosy v1.17.0 h1:qrdBhbylsHGIOUcUsZKUdVzq8fLvePIclHVSGdszyxk=
github.com/uozi-tech/cosy v1.17.0/go.mod h1:jEyznv+lmbb0YO0gU//yn4PnyqncTlyV2H5BpDa5aEw=
github.com/uozi-tech/cosy v1.18.0 h1:L0o1yQ6hTRdzUjWwcT/cJX0AcNaDaaL30gF8pJHUEzM=
github.com/uozi-tech/cosy v1.18.0/go.mod h1:8s8oQENTTGcmOGas/hkLvE+pZPyNG6AIblRbFgPRCwg=
github.com/uozi-tech/cosy-driver-mysql v0.2.2 h1:22S/XNIvuaKGqxQPsYPXN8TZ8hHjCQdcJKVQ83Vzxoo=
@ -1797,10 +1780,6 @@ github.com/uozi-tech/cosy-driver-postgres v0.2.1/go.mod h1:eAy1A89yHbAEfjkhNAifa
github.com/uozi-tech/cosy-driver-sqlite v0.2.1 h1:W+Z4pY25PSJCeReqroG7LIBeffsqotbpHzgqSMqZDIM=
github.com/uozi-tech/cosy-driver-sqlite v0.2.1/go.mod h1:2ya7Z5P3HzFi1ktfL8gvwaAGx0DDV0bmWxNSNpaLlwo=
github.com/urfave/cli/v2 v2.3.0/go.mod h1:LJmUH05zAU44vOAcrfzZQKsZbVcdbOG8rtL3/XcUArI=
github.com/urfave/cli/v3 v3.0.0-beta1 h1:6DTaaUarcM0wX7qj5Hcvs+5Dm3dyUTBbEwIWAjcw9Zg=
github.com/urfave/cli/v3 v3.0.0-beta1/go.mod h1:FnIeEMYu+ko8zP1F9Ypr3xkZMIDqW3DR92yUtY39q1Y=
github.com/urfave/cli/v3 v3.1.0 h1:kQR+oiqpJkBAONxBjM4RWivD4AfPHL/f4vqe/gjYU8M=
github.com/urfave/cli/v3 v3.1.0/go.mod h1:FJSKtM/9AiiTOJL4fJ6TbMUkxBXn7GO9guZqoZtpYpo=
github.com/urfave/cli/v3 v3.1.1 h1:bNnl8pFI5dxPOjeONvFCDFoECLQsceDG4ejahs4Jtxk=
github.com/urfave/cli/v3 v3.1.1/go.mod h1:FJSKtM/9AiiTOJL4fJ6TbMUkxBXn7GO9guZqoZtpYpo=
github.com/vinyldns/go-vinyldns v0.9.16 h1:GZJStDkcCk1F1AcRc64LuuMh+ENL8pHA0CVd4ulRMcQ=
@ -2679,7 +2658,6 @@ gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
gopkg.in/fsnotify.v1 v1.4.7 h1:xOHLXZwVvI9hhs+cLKq5+I5onOuwQLhQwiu63xxlHs4=
gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys=
gopkg.in/gcfg.v1 v1.2.3/go.mod h1:yesOnuUOFQAhST5vPY4nbZsb/huCgGGXlipJsBn0b3o=
gopkg.in/h2non/gock.v1 v1.0.15 h1:SzLqcIlb/fDfg7UvukMpNcWsu7sI5tWwL+KCATZqks0=

4
internal/cache/cache.go vendored
View file

@ -21,8 +21,8 @@ func Init() {
logger.Fatal("initializing local cache err", err)
}
// Initialize the nginx log scanner
InitNginxLogScanner()
// Initialize the config scanner
InitScanner()
}
func Set(key string, value interface{}, ttl time.Duration) {

395
internal/cache/nginx_log.go → internal/cache/index.go vendored
View file

@ -8,76 +8,82 @@ import (
"sync"
"time"
"github.com/0xJacky/Nginx-UI/internal/helper"
"github.com/0xJacky/Nginx-UI/internal/nginx"
"github.com/0xJacky/Nginx-UI/settings"
"github.com/fsnotify/fsnotify"
"github.com/uozi-tech/cosy/logger"
)
// NginxLogCache represents a cached log entry from nginx configuration
type NginxLogCache struct {
Path string `json:"path"` // Path to the log file
Type string `json:"type"` // Type of log: "access" or "error"
Name string `json:"name"` // Name of the log file
// ScanCallback is a function that gets called during config scanning
// It receives the config file path and contents
type ScanCallback func(configPath string, content []byte) error
// Scanner is responsible for scanning and watching nginx config files
type Scanner struct {
watcher *fsnotify.Watcher // File system watcher
scanTicker *time.Ticker // Ticker for periodic scanning
initialized bool // Whether the scanner has been initialized
scanning bool // Whether a scan is currently in progress
scanMutex sync.RWMutex // Mutex for protecting the scanning state
statusChan chan bool // Channel to broadcast scanning status changes
subscribers map[chan bool]struct{} // Set of subscribers
subscriberMux sync.RWMutex // Mutex for protecting the subscribers map
}
// NginxLogScanner is responsible for scanning and watching nginx config files for log directives
type NginxLogScanner struct {
logCache map[string]*NginxLogCache // Map of log path to cache entry
cacheMutex sync.RWMutex // Mutex for protecting the cache
watcher *fsnotify.Watcher // File system watcher
scanTicker *time.Ticker // Ticker for periodic scanning
initialized bool // Whether the scanner has been initialized
scanning bool // Whether a scan is currently in progress
scanMutex sync.RWMutex // Mutex for protecting the scanning state
statusChan chan bool // Channel to broadcast scanning status changes
subscribers map[chan bool]struct{} // Set of subscribers
subscriberMux sync.RWMutex // Mutex for protecting the subscribers map
// Global variables
var (
// scanner is the singleton instance of Scanner
scanner *Scanner
configScannerInitMux sync.Mutex
// This regex matches: include directives in nginx config files
includeRegex = regexp.MustCompile(`include\s+([^;]+);`)
// Global callbacks that will be executed during config file scanning
scanCallbacks []ScanCallback
scanCallbacksMutex sync.RWMutex
)
func init() {
// Initialize the callbacks slice
scanCallbacks = make([]ScanCallback, 0)
}
// Add regex constants at package level
var (
// logScanner is the singleton instance of NginxLogScanner
logScanner *NginxLogScanner
scannerInitMux sync.Mutex
)
// Compile the regular expressions for matching log directives
var (
// This regex matches: access_log or error_log, followed by a path, and optional parameters ending with semicolon
logDirectiveRegex = regexp.MustCompile(`(?m)(access_log|error_log)\s+([^\s;]+)(?:\s+[^;]+)?;`)
)
// InitNginxLogScanner initializes the nginx log scanner
func InitNginxLogScanner() {
scanner := GetNginxLogScanner()
err := scanner.Initialize()
// InitScanner initializes the config scanner
func InitScanner() {
s := GetScanner()
err := s.Initialize()
if err != nil {
logger.Error("Failed to initialize nginx log scanner:", err)
logger.Error("Failed to initialize config scanner:", err)
}
}
// GetNginxLogScanner returns the singleton instance of NginxLogScanner
func GetNginxLogScanner() *NginxLogScanner {
scannerInitMux.Lock()
defer scannerInitMux.Unlock()
// GetScanner returns the singleton instance of Scanner
func GetScanner() *Scanner {
configScannerInitMux.Lock()
defer configScannerInitMux.Unlock()
if logScanner == nil {
logScanner = &NginxLogScanner{
logCache: make(map[string]*NginxLogCache),
if scanner == nil {
scanner = &Scanner{
statusChan: make(chan bool, 10), // Buffer to prevent blocking
subscribers: make(map[chan bool]struct{}),
}
// Start broadcaster goroutine
go logScanner.broadcastStatus()
go scanner.broadcastStatus()
}
return logScanner
return scanner
}
// RegisterCallback adds a callback function to be executed during scans
// This function can be called before Scanner is initialized
func RegisterCallback(callback ScanCallback) {
scanCallbacksMutex.Lock()
defer scanCallbacksMutex.Unlock()
scanCallbacks = append(scanCallbacks, callback)
}
// broadcastStatus listens for status changes and broadcasts to all subscribers
func (s *NginxLogScanner) broadcastStatus() {
func (s *Scanner) broadcastStatus() {
for status := range s.statusChan {
s.subscriberMux.RLock()
for ch := range s.subscribers {
@ -92,9 +98,9 @@ func (s *NginxLogScanner) broadcastStatus() {
}
}
// SubscribeStatusChanges allows a client to subscribe to scanning status changes
func SubscribeStatusChanges() chan bool {
s := GetNginxLogScanner()
// SubscribeScanningStatus allows a client to subscribe to scanning status changes
func SubscribeScanningStatus() chan bool {
s := GetScanner()
ch := make(chan bool, 5) // Buffer to prevent blocking
// Add to subscribers
@ -116,9 +122,9 @@ func SubscribeStatusChanges() chan bool {
return ch
}
// UnsubscribeStatusChanges removes a subscriber from receiving status updates
func UnsubscribeStatusChanges(ch chan bool) {
s := GetNginxLogScanner()
// UnsubscribeScanningStatus removes a subscriber from receiving status updates
func UnsubscribeScanningStatus(ch chan bool) {
s := GetScanner()
s.subscriberMux.Lock()
delete(s.subscribers, ch)
@ -128,8 +134,8 @@ func UnsubscribeStatusChanges(ch chan bool) {
close(ch)
}
// Initialize sets up the log scanner and starts watching for file changes
func (s *NginxLogScanner) Initialize() error {
// Initialize sets up the scanner and starts watching for file changes
func (s *Scanner) Initialize() error {
if s.initialized {
return nil
}
@ -209,7 +215,7 @@ func (s *NginxLogScanner) Initialize() error {
}
// watchForChanges handles the fsnotify events and triggers rescans when necessary
func (s *NginxLogScanner) watchForChanges() {
func (s *Scanner) watchForChanges() {
for {
select {
case event, ok := <-s.watcher.Events:
@ -228,7 +234,7 @@ func (s *NginxLogScanner) watchForChanges() {
}
}
// Process file changes - no .conf restriction anymore
// Process file changes
if !event.Has(fsnotify.Remove) {
logger.Debug("Config file changed:", event.Name)
// Give the system a moment to finish writing the file
@ -239,9 +245,7 @@ func (s *NginxLogScanner) watchForChanges() {
logger.Error("Failed to scan changed file:", err)
}
} else {
// For removed files, we need to clean up any log entries that came from this file
// This would require tracking which logs came from which config files
// For now, we'll do a full rescan which is simpler but less efficient
// For removed files, we need a full rescan
err := s.ScanAllConfigs()
if err != nil {
logger.Error("Failed to rescan configs after file removal:", err)
@ -257,8 +261,8 @@ func (s *NginxLogScanner) watchForChanges() {
}
}
// scanSingleFile scans a single file and updates the log cache accordingly
func (s *NginxLogScanner) scanSingleFile(filePath string) error {
// scanSingleFile scans a single file and executes all registered callbacks
func (s *Scanner) scanSingleFile(filePath string) error {
// Set scanning state to true
s.scanMutex.Lock()
wasScanning := s.scanning
@ -278,134 +282,30 @@ func (s *NginxLogScanner) scanSingleFile(filePath string) error {
s.scanMutex.Unlock()
}()
// Create a temporary cache for new entries from this file
newEntries := make(map[string]*NginxLogCache)
// Scan the file
err := s.scanConfigFile(filePath, newEntries)
if err != nil {
return err
}
// Update the main cache with new entries
s.cacheMutex.Lock()
for path, entry := range newEntries {
s.logCache[path] = entry
}
s.cacheMutex.Unlock()
return nil
}
// ScanAllConfigs scans all nginx config files for log directives
func (s *NginxLogScanner) ScanAllConfigs() error {
// Set scanning state to true
s.scanMutex.Lock()
wasScanning := s.scanning
s.scanning = true
if !wasScanning {
// Only broadcast if status changed from not scanning to scanning
s.statusChan <- true
}
s.scanMutex.Unlock()
// Ensure we reset scanning state when done
defer func() {
s.scanMutex.Lock()
s.scanning = false
// Broadcast the completion
s.statusChan <- false
s.scanMutex.Unlock()
}()
// Initialize a new cache to replace the old one
newCache := make(map[string]*NginxLogCache)
// Get the main config file
mainConfigPath := nginx.GetConfPath("", "nginx.conf")
err := s.scanConfigFile(mainConfigPath, newCache)
if err != nil {
logger.Error("Failed to scan main config:", err)
}
// Scan sites-available directory - no .conf restriction anymore
sitesAvailablePath := nginx.GetConfPath("sites-available", "")
sitesAvailableFiles, err := os.ReadDir(sitesAvailablePath)
if err == nil {
for _, file := range sitesAvailableFiles {
if !file.IsDir() {
configPath := filepath.Join(sitesAvailablePath, file.Name())
err := s.scanConfigFile(configPath, newCache)
if err != nil {
logger.Error("Failed to scan config:", configPath, err)
}
}
}
}
// Scan stream-available directory if it exists
streamAvailablePath := nginx.GetConfPath("stream-available", "")
streamAvailableFiles, err := os.ReadDir(streamAvailablePath)
if err == nil {
for _, file := range streamAvailableFiles {
if !file.IsDir() {
configPath := filepath.Join(streamAvailablePath, file.Name())
err := s.scanConfigFile(configPath, newCache)
if err != nil {
logger.Error("Failed to scan stream config:", configPath, err)
}
}
}
}
// Replace the old cache with the new one
s.cacheMutex.Lock()
s.logCache = newCache
s.cacheMutex.Unlock()
return nil
}
// scanConfigFile scans a single config file for log directives using regex
func (s *NginxLogScanner) scanConfigFile(configPath string, cache map[string]*NginxLogCache) error {
// Open the file
file, err := os.Open(configPath)
file, err := os.Open(filePath)
if err != nil {
return err
}
defer file.Close()
// Read the entire file content
content, err := os.ReadFile(configPath)
content, err := os.ReadFile(filePath)
if err != nil {
return err
}
// Find all matches of log directives
matches := logDirectiveRegex.FindAllSubmatch(content, -1)
for _, match := range matches {
if len(match) >= 3 {
directiveType := string(match[1]) // "access_log" or "error_log"
logPath := string(match[2]) // The log file path
// Validate the log path
if isValidLogPath(logPath) {
logType := "access"
if directiveType == "error_log" {
logType = "error"
}
cache[logPath] = &NginxLogCache{
Path: logPath,
Type: logType,
Name: filepath.Base(logPath),
}
}
// Execute all registered callbacks
scanCallbacksMutex.RLock()
for _, callback := range scanCallbacks {
err := callback(filePath, content)
if err != nil {
logger.Error("Callback error for file", filePath, ":", err)
}
}
scanCallbacksMutex.RUnlock()
// Look for include directives to process included files
includeRegex := regexp.MustCompile(`include\s+([^;]+);`)
includeMatches := includeRegex.FindAllSubmatch(content, -1)
for _, match := range includeMatches {
@ -430,7 +330,7 @@ func (s *NginxLogScanner) scanConfigFile(configPath string, cache map[string]*Ng
for _, matchedFile := range matchedFiles {
fileInfo, err := os.Stat(matchedFile)
if err == nil && !fileInfo.IsDir() {
err = s.scanConfigFile(matchedFile, cache)
err = s.scanSingleFile(matchedFile)
if err != nil {
logger.Error("Failed to scan included file:", matchedFile, err)
}
@ -446,7 +346,7 @@ func (s *NginxLogScanner) scanConfigFile(configPath string, cache map[string]*Ng
fileInfo, err := os.Stat(includePath)
if err == nil && !fileInfo.IsDir() {
err = s.scanConfigFile(includePath, cache)
err = s.scanSingleFile(includePath)
if err != nil {
logger.Error("Failed to scan included file:", includePath, err)
}
@ -458,77 +358,69 @@ func (s *NginxLogScanner) scanConfigFile(configPath string, cache map[string]*Ng
return nil
}
// isLogPathUnderWhiteList checks if the log path is under one of the paths in LogDirWhiteList
// This is a duplicate of the function in nginx_log package to avoid import cycle
func isLogPathUnderWhiteList(path string) bool {
// deep copy
logDirWhiteList := append([]string{}, settings.NginxSettings.LogDirWhiteList...)
accessLogPath := nginx.GetAccessLogPath()
errorLogPath := nginx.GetErrorLogPath()
if accessLogPath != "" {
logDirWhiteList = append(logDirWhiteList, filepath.Dir(accessLogPath))
}
if errorLogPath != "" {
logDirWhiteList = append(logDirWhiteList, filepath.Dir(errorLogPath))
// ScanAllConfigs scans all nginx config files and executes all registered callbacks
func (s *Scanner) ScanAllConfigs() error {
// Set scanning state to true
s.scanMutex.Lock()
wasScanning := s.scanning
s.scanning = true
if !wasScanning {
// Only broadcast if status changed from not scanning to scanning
s.statusChan <- true
}
s.scanMutex.Unlock()
for _, whitePath := range logDirWhiteList {
if helper.IsUnderDirectory(path, whitePath) {
return true
}
}
return false
}
// Ensure we reset scanning state when done
defer func() {
s.scanMutex.Lock()
s.scanning = false
// Broadcast the completion
s.statusChan <- false
s.scanMutex.Unlock()
}()
// isValidLogPath checks if a log path is valid:
// 1. It must be a regular file or a symlink to a regular file
// 2. It must not point to a console or special device
// 3. It must be under the whitelist directories
func isValidLogPath(logPath string) bool {
// First check if the path is under the whitelist
if !isLogPathUnderWhiteList(logPath) {
logger.Warn("Log path is not under whitelist:", logPath)
return false
}
// Check if the path exists
fileInfo, err := os.Lstat(logPath)
// Get the main config file
mainConfigPath := nginx.GetConfPath("", "nginx.conf")
err := s.scanSingleFile(mainConfigPath)
if err != nil {
// If file doesn't exist, it might be created later
// We'll assume it's valid for now
return true
logger.Error("Failed to scan main config:", err)
}
// If it's a symlink, follow it
if fileInfo.Mode()&os.ModeSymlink != 0 {
linkTarget, err := os.Readlink(logPath)
if err != nil {
return false
// Scan sites-available directory
sitesAvailablePath := nginx.GetConfPath("sites-available", "")
sitesAvailableFiles, err := os.ReadDir(sitesAvailablePath)
if err == nil {
for _, file := range sitesAvailableFiles {
if !file.IsDir() {
configPath := filepath.Join(sitesAvailablePath, file.Name())
err := s.scanSingleFile(configPath)
if err != nil {
logger.Error("Failed to scan config:", configPath, err)
}
}
}
// Make absolute path if the link target is relative
if !filepath.IsAbs(linkTarget) {
linkTarget = filepath.Join(filepath.Dir(logPath), linkTarget)
}
// Check the target file
targetInfo, err := os.Stat(linkTarget)
if err != nil {
return false
}
// Only accept regular files as targets
return targetInfo.Mode().IsRegular()
}
// For non-symlinks, just check if it's a regular file
return fileInfo.Mode().IsRegular()
// Scan stream-available directory if it exists
streamAvailablePath := nginx.GetConfPath("stream-available", "")
streamAvailableFiles, err := os.ReadDir(streamAvailablePath)
if err == nil {
for _, file := range streamAvailableFiles {
if !file.IsDir() {
configPath := filepath.Join(streamAvailablePath, file.Name())
err := s.scanSingleFile(configPath)
if err != nil {
logger.Error("Failed to scan stream config:", configPath, err)
}
}
}
}
return nil
}
// Shutdown cleans up resources used by the scanner
func (s *NginxLogScanner) Shutdown() {
func (s *Scanner) Shutdown() {
if s.watcher != nil {
s.watcher.Close()
}
@ -551,34 +443,9 @@ func (s *NginxLogScanner) Shutdown() {
close(s.statusChan)
}
// GetAllLogPaths returns all cached log paths
func GetAllLogPaths(filters ...func(*NginxLogCache) bool) []*NginxLogCache {
s := GetNginxLogScanner()
s.cacheMutex.RLock()
defer s.cacheMutex.RUnlock()
result := make([]*NginxLogCache, 0, len(s.logCache))
for _, cache := range s.logCache {
flag := true
if len(filters) > 0 {
for _, filter := range filters {
if !filter(cache) {
flag = false
break
}
}
}
if flag {
result = append(result, cache)
}
}
return result
}
// IsScanning returns whether a scan is currently in progress
func IsScanning() bool {
s := GetNginxLogScanner()
// IsScanningInProgress returns whether a scan is currently in progress
func IsScanningInProgress() bool {
s := GetScanner()
s.scanMutex.RLock()
defer s.scanMutex.RUnlock()
return s.scanning

82
internal/nginx/nginx_directives.json
View file

@ -161,6 +161,11 @@
"https://nginx.org/en/docs/http/ngx_http_auth_jwt_module.html#auth_jwt_type"
]
},
"auth_oidc": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_oidc_module.html#auth_oidc"
]
},
"auth_request": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_auth_request_module.html#auth_request"
@ -251,16 +256,36 @@
"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_header_timeout"
]
},
"client_id": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_oidc_module.html#client_id"
]
},
"client_max_body_size": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size"
]
},
"client_secret": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_oidc_module.html#client_secret"
]
},
"config_url": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_oidc_module.html#config_url"
]
},
"connection_pool_size": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_core_module.html#connection_pool_size"
]
},
"cookie_name": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_oidc_module.html#cookie_name"
]
},
"create_full_put_path": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_dav_module.html#create_full_put_path"
@ -357,6 +382,11 @@
"https://nginx.org/en/docs/http/ngx_http_headers_module.html#expires"
]
},
"extra_auth_args": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_oidc_module.html#extra_auth_args"
]
},
"f4f": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_f4f_module.html#f4f"
@ -1098,6 +1128,11 @@
"https://nginx.org/en/docs/http/ngx_http_upstream_module.html#ip_hash"
]
},
"issuer": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_oidc_module.html#issuer"
]
},
"js_access": {
"links": [
"https://nginx.org/en/docs/stream/ngx_stream_js_module.html#js_access"
@ -1639,6 +1674,11 @@
"https://nginx.org/en/docs/http/ngx_http_upstream_module.html#ntlm"
]
},
"oidc_provider": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_oidc_module.html#oidc_provider"
]
},
"open_file_cache": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_core_module.html#open_file_cache"
@ -1670,6 +1710,11 @@
"https://nginx.org/en/docs/ngx_otel_module.html#otel_exporter"
]
},
"otel_resource_attr": {
"links": [
"https://nginx.org/en/docs/ngx_otel_module.html#otel_resource_attr"
]
},
"otel_service_name": {
"links": [
"https://nginx.org/en/docs/ngx_otel_module.html#otel_service_name"
@ -1775,6 +1820,11 @@
"https://nginx.org/en/docs/mail/ngx_mail_core_module.html#protocol"
]
},
"proxy": {
"links": [
"https://nginx.org/en/docs/ngx_mgmt_module.html#proxy"
]
},
"proxy_bind": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_bind",
@ -2027,6 +2077,11 @@
"https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass_trailers"
]
},
"proxy_password": {
"links": [
"https://nginx.org/en/docs/ngx_mgmt_module.html#proxy_password"
]
},
"proxy_protocol": {
"links": [
"https://nginx.org/en/docs/mail/ngx_mail_proxy_module.html#proxy_protocol",
@ -2225,6 +2280,11 @@
"https://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_upload_rate"
]
},
"proxy_username": {
"links": [
"https://nginx.org/en/docs/ngx_mgmt_module.html#proxy_username"
]
},
"queue": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_upstream_module.html#queue"
@ -2286,6 +2346,11 @@
"https://nginx.org/en/docs/http/ngx_http_core_module.html#recursive_error_pages"
]
},
"redirect_uri": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_oidc_module.html#redirect_uri"
]
},
"referer_hash_bucket_size": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_referer_module.html#referer_hash_bucket_size"
@ -2576,6 +2641,11 @@
"https://nginx.org/en/docs/http/ngx_http_scgi_module.html#scgi_temp_path"
]
},
"scope": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_oidc_module.html#scope"
]
},
"secure_link": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_secure_link_module.html#secure_link"
@ -2664,6 +2734,16 @@
"https://nginx.org/en/docs/http/ngx_http_session_log_module.html#session_log_zone"
]
},
"session_store": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_oidc_module.html#session_store"
]
},
"session_timeout": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_oidc_module.html#session_timeout"
]
},
"set": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_rewrite_module.html#set",
@ -2802,6 +2882,7 @@
},
"ssl_crl": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_oidc_module.html#ssl_crl",
"https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_crl",
"https://nginx.org/en/docs/mail/ngx_mail_ssl_module.html#ssl_crl",
"https://nginx.org/en/docs/stream/ngx_stream_ssl_module.html#ssl_crl",
@ -2952,6 +3033,7 @@
},
"ssl_trusted_certificate": {
"links": [
"https://nginx.org/en/docs/http/ngx_http_oidc_module.html#ssl_trusted_certificate",
"https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_trusted_certificate",
"https://nginx.org/en/docs/mail/ngx_mail_ssl_module.html#ssl_trusted_certificate",
"https://nginx.org/en/docs/stream/ngx_stream_ssl_module.html#ssl_trusted_certificate",

68
internal/nginx_log/log_cache.go Normal file
View file

@ -0,0 +1,68 @@
package nginx_log
import (
"sync"
)
// NginxLogCache represents a cached log entry from nginx configuration
type NginxLogCache struct {
Path string `json:"path"` // Path to the log file
Type string `json:"type"` // Type of log: "access" or "error"
Name string `json:"name"` // Name of the log file
}
var (
// logCache is the map to store all found log files
logCache map[string]*NginxLogCache
cacheMutex sync.RWMutex
)
func init() {
// Initialize the cache
logCache = make(map[string]*NginxLogCache)
}
// AddLogPath adds a log path to the log cache
func AddLogPath(path, logType, name string) {
cacheMutex.Lock()
defer cacheMutex.Unlock()
logCache[path] = &NginxLogCache{
Path: path,
Type: logType,
Name: name,
}
}
// GetAllLogPaths returns all cached log paths
func GetAllLogPaths(filters ...func(*NginxLogCache) bool) []*NginxLogCache {
cacheMutex.RLock()
defer cacheMutex.RUnlock()
result := make([]*NginxLogCache, 0, len(logCache))
for _, cache := range logCache {
flag := true
if len(filters) > 0 {
for _, filter := range filters {
if !filter(cache) {
flag = false
break
}
}
}
if flag {
result = append(result, cache)
}
}
return result
}
// ClearLogCache clears all entries in the log cache
func ClearLogCache() {
cacheMutex.Lock()
defer cacheMutex.Unlock()
// Clear the cache
logCache = make(map[string]*NginxLogCache)
}

15
internal/nginx_log/log_list.go
View file

@ -2,10 +2,10 @@ package nginx_log
import (
"slices"
"github.com/0xJacky/Nginx-UI/internal/cache"
)
// typeToInt converts log type string to a sortable integer
// "access" = 0, "error" = 1
func typeToInt(t string) int {
if t == "access" {
return 0
@ -13,7 +13,9 @@ func typeToInt(t string) int {
return 1
}
func sortCompare(i, j *cache.NginxLogCache, key string, order string) bool {
// sortCompare compares two log entries based on the specified key and order
// Returns true if i should come after j in the sorted list
func sortCompare(i, j *NginxLogCache, key string, order string) bool {
flag := false
switch key {
@ -32,8 +34,11 @@ func sortCompare(i, j *cache.NginxLogCache, key string, order string) bool {
return flag
}
func Sort(key string, order string, configs []*cache.NginxLogCache) []*cache.NginxLogCache {
slices.SortStableFunc(configs, func(i, j *cache.NginxLogCache) int {
// Sort sorts a list of NginxLogCache entries by the specified key and order
// Supported keys: "type", "name"
// Supported orders: "asc", "desc"
func Sort(key string, order string, configs []*NginxLogCache) []*NginxLogCache {
slices.SortStableFunc(configs, func(i, j *NginxLogCache) int {
if sortCompare(i, j, key, order) {
return 1
}

103
internal/nginx_log/nginx_log.go
View file

@ -2,19 +2,114 @@ package nginx_log
import (
"fmt"
"os"
"path/filepath"
"regexp"
"github.com/0xJacky/Nginx-UI/internal/cache"
"github.com/0xJacky/Nginx-UI/internal/helper"
"github.com/0xJacky/Nginx-UI/internal/nginx"
"github.com/0xJacky/Nginx-UI/settings"
"path/filepath"
"github.com/uozi-tech/cosy/logger"
)
// IsLogPathUnderWhiteList checks if the log path is under one of the paths in LogDirWhiteList
// Regular expression for log directives - matches access_log or error_log
var logDirectiveRegex = regexp.MustCompile(`(?m)(access_log|error_log)\s+([^\s;]+)(?:\s+[^;]+)?;`)
// Use init function to automatically register callback
func init() {
// Register the callback directly with the global registry
cache.RegisterCallback(scanForLogDirectives)
}
// scanForLogDirectives scans and parses configuration files for log directives
func scanForLogDirectives(configPath string, content []byte) error {
// Clear previous scan results when scanning the main config
if configPath == nginx.GetConfPath("", "nginx.conf") {
ClearLogCache()
}
// Find log directives using regex
matches := logDirectiveRegex.FindAllSubmatch(content, -1)
// Parse log paths
for _, match := range matches {
if len(match) >= 3 {
directiveType := string(match[1]) // "access_log" or "error_log"
logPath := string(match[2]) // Path to log file
// Validate log path
if IsLogPathUnderWhiteList(logPath) && isValidLogPath(logPath) {
logType := "access"
if directiveType == "error_log" {
logType = "error"
}
// Add to cache
AddLogPath(logPath, logType, filepath.Base(logPath))
}
}
}
return nil
}
// GetAllLogs returns all log paths
func GetAllLogs(filters ...func(*NginxLogCache) bool) []*NginxLogCache {
return GetAllLogPaths(filters...)
}
// isValidLogPath checks if a log path is valid:
// 1. It must be a regular file or a symlink to a regular file
// 2. It must not point to a console or special device
// 3. It must be under the whitelist directories
func isValidLogPath(logPath string) bool {
// First check if the path is in the whitelist
if !IsLogPathUnderWhiteList(logPath) {
logger.Warn("Log path is not under whitelist:", logPath)
return false
}
// Check if the path exists
fileInfo, err := os.Lstat(logPath)
if err != nil {
// If the file doesn't exist, it might be created later
// We'll assume it's valid for now
return true
}
// If it's a symlink, follow it
if fileInfo.Mode()&os.ModeSymlink != 0 {
linkTarget, err := os.Readlink(logPath)
if err != nil {
return false
}
// Make the link target path absolute if it's relative
if !filepath.IsAbs(linkTarget) {
linkTarget = filepath.Join(filepath.Dir(logPath), linkTarget)
}
// Check the target file
targetInfo, err := os.Stat(linkTarget)
if err != nil {
return false
}
// Only accept regular files as targets
return targetInfo.Mode().IsRegular()
}
// For non-symlinks, just check if it's a regular file
return fileInfo.Mode().IsRegular()
}
// IsLogPathUnderWhiteList checks if a log path is under one of the paths in LogDirWhiteList
func IsLogPathUnderWhiteList(path string) bool {
cacheKey := fmt.Sprintf("isLogPathUnderWhiteList:%s", path)
res, ok := cache.Get(cacheKey)
// deep copy
// Deep copy the whitelist
logDirWhiteList := append([]string{}, settings.NginxSettings.LogDirWhiteList...)
accessLogPath := nginx.GetAccessLogPath()
@ -27,7 +122,7 @@ func IsLogPathUnderWhiteList(path string) bool {
logDirWhiteList = append(logDirWhiteList, filepath.Dir(errorLogPath))
}
// no cache, check it
// No cache, check it
if !ok {
for _, whitePath := range logDirWhiteList {
if helper.IsUnderDirectory(path, whitePath) {

2
router/routers.go
View file

@ -10,6 +10,7 @@ import (
"github.com/0xJacky/Nginx-UI/api/cluster"
"github.com/0xJacky/Nginx-UI/api/config"
"github.com/0xJacky/Nginx-UI/api/crypto"
"github.com/0xJacky/Nginx-UI/api/index"
"github.com/0xJacky/Nginx-UI/api/nginx"
nginxLog "github.com/0xJacky/Nginx-UI/api/nginx_log"
"github.com/0xJacky/Nginx-UI/api/notification"
@ -82,6 +83,7 @@ func InitRouter() {
{
terminal.InitRouter(o)
}
index.InitRouter(w)
nginxLog.InitRouter(w)
upstream.InitRouter(w)
system.InitWebSocketRouter(w)