diff --git a/go.mod b/go.mod index 43048da..b730e15 100644 --- a/go.mod +++ b/go.mod @@ -26,6 +26,8 @@ require ( require ( github.com/Microsoft/go-winio v0.6.2 // indirect + github.com/PuerkitoBio/goquery v1.10.1 // indirect + github.com/andybalholm/cascadia v1.3.3 // indirect github.com/beorn7/perks v1.0.1 // indirect github.com/cenkalti/backoff/v4 v4.3.0 // indirect github.com/cespare/xxhash/v2 v2.3.0 // indirect @@ -61,6 +63,7 @@ require ( github.com/prometheus/common v0.61.0 // indirect github.com/prometheus/procfs v0.15.1 // indirect github.com/sirupsen/logrus v1.9.3 // indirect + github.com/vincent-petithory/dataurl v1.0.0 // indirect go.opentelemetry.io/auto/sdk v1.1.0 // indirect go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.58.0 // indirect go.opentelemetry.io/otel v1.33.0 // indirect diff --git a/go.sum b/go.sum index 1b03c54..684d562 100644 --- a/go.sum +++ b/go.sum @@ -2,6 +2,10 @@ github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 h1:UQHMgLO+TxOEl github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1/go.mod h1:xomTg63KZ2rFqZQzSB4Vz2SUXa1BpHTVz9L5PTmPC4E= github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY= github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU= +github.com/PuerkitoBio/goquery v1.10.1 h1:Y8JGYUkXWTGRB6Ars3+j3kN0xg1YqqlwvdTV8WTFQcU= +github.com/PuerkitoBio/goquery v1.10.1/go.mod h1:IYiHrOMps66ag56LEH7QYDDupKXyo5A8qrjIx3ZtujY= +github.com/andybalholm/cascadia v1.3.3 h1:AG2YHrzJIm4BZ19iwJ/DAua6Btl3IwJX+VI4kktS1LM= +github.com/andybalholm/cascadia v1.3.3/go.mod h1:xNd9bqTn98Ln4DwST8/nG+H0yuB8Hmgu1YHNnWw0GeA= github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM= github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw= github.com/cenkalti/backoff/v4 v4.3.0 h1:MyRJ/UdXutAwSAT+s3wNd7MfTIcy71VQueUuFK343L8= @@ -139,8 +143,11 @@ github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+ github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/vincent-petithory/dataurl v1.0.0 h1:cXw+kPto8NLuJtlMsI152irrVw9fRDX8AbShPRpg2CI= +github.com/vincent-petithory/dataurl v1.0.0/go.mod h1:FHafX5vmDzyP+1CQATJn7WFKc9CvnvxyvZy6I1MrG/U= github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= go.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA= go.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A= go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.58.0 h1:yd02MEjBdJkG3uabWP9apV+OuWRIXGDuJEUJbOHmCFU= @@ -162,16 +169,34 @@ go.opentelemetry.io/proto/otlp v1.3.1/go.mod h1:0X1WI4de4ZsLrrJNLAQbFeLCm3T7yBkR golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc= +golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= +golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8= +golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk= golang.org/x/crypto v0.32.0 h1:euUpcYgM8WcP71gNpTqQCn6rC2t6ULUPiOzfWaXVVfc= golang.org/x/crypto v0.32.0/go.mod h1:ZnnJkOaASj8g0AjIduWNlq2NRxL0PlBrbKVyZ6V/Ugc= golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.15.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= +golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/mod v0.22.0 h1:D4nJWe9zXqHOmWqj4VMOJhvzj7bEZg4wEYa759z1pH4= golang.org/x/mod v0.22.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= +golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= +golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk= +golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44= +golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= +golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4= golang.org/x/net v0.34.0 h1:Mb7Mrk043xzHgnRM88suvJFwzVrRfHEHJEl5/71CKw0= golang.org/x/net v0.34.0/go.mod h1:di0qlW3YNM5oh6GqDGQr92MyTozJPmybPK4Ev/Gm31k= golang.org/x/oauth2 v0.25.0 h1:CY4y7XT9v0cRI9oupztF8AgiIu99L/ksR/Xp/6jrZ70= @@ -179,19 +204,48 @@ golang.org/x/oauth2 v0.25.0/go.mod h1:XYTD2NtWslqkgxebSiOHnXEap4TF09sJSc7H1sXbht golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y= +golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sync v0.10.0 h1:3NQrjDixjgGwUOCaF8w2+VYHv0Ve/vGYSbdkTa98gmQ= golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU= golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= +golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= +golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU= +golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk= +golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY= +golang.org/x/term v0.27.0/go.mod h1:iMsnZpn0cago0GOrHO2+Y7u7JPn5AylBrcoWkElMTSM= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= +golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo= golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ= golang.org/x/time v0.9.0 h1:EsRrnYcQiGH+5FfbgvV4AP7qEZstoyrHB0DzarOQ4ZY= @@ -200,6 +254,10 @@ golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGm golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= +golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= +golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58= +golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk= golang.org/x/tools v0.29.0 h1:Xx0h3TtM9rzQpQuR4dKLrdglAmCEN5Oi+P74JdhdzXE= golang.org/x/tools v0.29.0/go.mod h1:KMQVMRsVxU6nHCFXrBPhDB8XncLNLM0lIy/F14RP588= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/internal/api/handler.go b/internal/api/handler.go index 6d1f80a..a8d1bef 100644 --- a/internal/api/handler.go +++ b/internal/api/handler.go @@ -37,6 +37,7 @@ func NewHandler(cfg config.ConfigInstance) http.Handler { mux.HandleFunc("GET", "/v1/schema/{filename...}", v1.GetSchemaFile) mux.HandleFunc("GET", "/v1/stats", useCfg(cfg, v1.Stats)) mux.HandleFunc("GET", "/v1/stats/ws", useCfg(cfg, v1.StatsWS)) + mux.HandleFunc("GET", "/v1/favicon/{alias}", auth.RequireAuth(v1.GetFavIcon)) return mux } diff --git a/internal/api/v1/favicon.go b/internal/api/v1/favicon.go new file mode 100644 index 0000000..e0b324c --- /dev/null +++ b/internal/api/v1/favicon.go @@ -0,0 +1,200 @@ +package v1 + +import ( + "bytes" + "context" + "errors" + "io" + "net/http" + "strings" + "sync" + "time" + + "github.com/PuerkitoBio/goquery" + "github.com/vincent-petithory/dataurl" + U "github.com/yusing/go-proxy/internal/api/v1/utils" + "github.com/yusing/go-proxy/internal/logging" + route "github.com/yusing/go-proxy/internal/route/types" +) + +type content struct { + header http.Header + data []byte + status int +} + +func newContent() *content { + return &content{ + header: make(http.Header), + } +} + +func (c *content) Header() http.Header { + return c.header +} + +func (c *content) Write(data []byte) (int, error) { + c.data = append(c.data, data...) + return len(data), nil +} + +func (c *content) WriteHeader(statusCode int) { + c.status = statusCode +} + +// GetFavIcon returns the favicon of the route +// +// Returns: +// - 200 OK: if icon found +// - 400 Bad Request: if alias is empty or route is not HTTPRoute +// - 404 Not Found: if route or icon not found +// - 500 Internal Server Error: if internal error +// - others: depends on route handler response +func GetFavIcon(w http.ResponseWriter, req *http.Request) { + alias := req.PathValue("alias") + if alias == "" { + U.RespondError(w, U.ErrMissingKey("alias"), http.StatusBadRequest) + return + } + r := listRoute(alias) + if r == nil { + http.NotFound(w, req) + return + } + switch r := r.(type) { + case route.HTTPRoute: + var icon []byte + var status int + var errMsg string + + homepage := r.RawEntry().Homepage + if homepage != nil && homepage.Icon != nil { + if homepage.Icon.IsRelative { + icon, status, errMsg = findIcon(r, req, homepage.Icon.Value) + } else { + icon, status, errMsg = getIconAbsolute(homepage.Icon.Value) + } + } else { + // try extract from "link[rel=icon]" + icon, status, errMsg = findIcon(r, req, "/") + } + if status != http.StatusOK { + http.Error(w, errMsg, status) + return + } + U.WriteBody(w, icon) + default: + http.Error(w, "bad request", http.StatusBadRequest) + } +} + +// cache key can be absolute url or route name. +var ( + iconCache = make(map[string][]byte) + iconCacheMu sync.RWMutex +) + +func loadIconCache(key string) (icon []byte, ok bool) { + iconCacheMu.RLock() + icon, ok = iconCache[key] + iconCacheMu.RUnlock() + return +} + +func storeIconCache(key string, icon []byte) { + iconCacheMu.Lock() + defer iconCacheMu.Unlock() + iconCache[key] = icon +} + +func getIconAbsolute(url string) ([]byte, int, string) { + icon, ok := loadIconCache(url) + if ok { + return icon, http.StatusOK, "" + } + + resp, err := U.Get(url) + if err != nil { + storeIconCache(url, nil) + logging.Error().Err(err). + Str("url", url). + Msg("failed to get icon") + return nil, http.StatusBadGateway, "connection error" + } + + defer resp.Body.Close() + icon, err = io.ReadAll(resp.Body) + if err != nil { + // storeIconCache(url, nil) // can retry + logging.Error().Err(err). + Str("url", url). + Msg("failed to read icon") + return nil, http.StatusInternalServerError, "internal error" + } + + storeIconCache(url, icon) + return icon, http.StatusOK, "" +} + +func findIcon(r route.HTTPRoute, req *http.Request, path string) (icon []byte, status int, errMsg string) { + key := r.TargetName() + icon, ok := loadIconCache(key) + if ok { + if icon == nil { + return nil, http.StatusNotFound, "icon not found" + } + return icon, http.StatusOK, "" + } + + icon, status, errMsg = findIconSlow(r, req, path) + // set even if error (nil) + storeIconCache(key, icon) + return +} + +func findIconSlow(r route.HTTPRoute, req *http.Request, path string) (icon []byte, status int, errMsg string) { + c := newContent() + ctx, cancel := context.WithTimeoutCause(req.Context(), 3*time.Second, errors.New("favicon request timeout")) + defer cancel() + newReq := req.WithContext(ctx) + newReq.URL.Path = path + newReq.URL.RawPath = path + newReq.URL.RawQuery = "" + newReq.RequestURI = path + r.ServeHTTP(c, newReq) + if c.status != http.StatusOK { + return nil, c.status, "upstream error: " + http.StatusText(c.status) + } + // return icon data + if path != "/" { + return c.data, http.StatusOK, "" + } + // try extract from "link[rel=icon]" from path "/" + doc, err := goquery.NewDocumentFromReader(bytes.NewBuffer(c.data)) + if err != nil { + return nil, http.StatusInternalServerError, "internal error" + } + ele := doc.Find("link[rel=icon]").First() + if ele.Length() == 0 { + return nil, http.StatusNotFound, "icon not found" + } + href := ele.AttrOr("href", "") + if href == "" { + return nil, http.StatusNotFound, "icon not found" + } + // https://en.wikipedia.org/wiki/Data_URI_scheme + if strings.HasPrefix(href, "data:image/") { + dataURI, err := dataurl.DecodeString(href) + if err != nil { + logging.Error().Err(err). + Str("route", r.TargetName()). + Msg("failed to decode favicon") + return nil, http.StatusInternalServerError, "internal error" + } + return dataURI.Data, http.StatusOK, "" + } + if href[0] != '/' { + return getIconAbsolute(href) + } + return findIconSlow(r, req, href) +} diff --git a/internal/homepage/homepage.go b/internal/homepage/homepage.go index a96df4c..dc455de 100644 --- a/internal/homepage/homepage.go +++ b/internal/homepage/homepage.go @@ -1,5 +1,7 @@ package homepage +import "strings" + type ( //nolint:recvcheck Config map[string]Category @@ -8,7 +10,7 @@ type ( Item struct { Show bool `json:"show"` Name string `json:"name"` // display name - Icon string `json:"icon"` + Icon *IconURL `json:"icon"` URL string `json:"url"` // alias + domain Category string `json:"category"` Description string `json:"description" aliases:"desc"` @@ -22,7 +24,7 @@ type ( func (item *Item) IsEmpty() bool { return item == nil || (item.Name == "" && - item.Icon == "" && + item.Icon == nil && item.URL == "" && item.Category == "" && item.Description == "" && @@ -37,6 +39,13 @@ func (c *Config) Clear() { *c = make(Config) } +var cleanName = strings.NewReplacer( + " ", "-", + "_", "-", + "(", "", + ")", "", +) + func (c Config) Add(item *Item) { if c[item.Category] == nil { c[item.Category] = make(Category, 0) diff --git a/internal/homepage/icon_url.go b/internal/homepage/icon_url.go new file mode 100644 index 0000000..471abcf --- /dev/null +++ b/internal/homepage/icon_url.go @@ -0,0 +1,46 @@ +package homepage + +import ( + "strings" + + E "github.com/yusing/go-proxy/internal/error" +) + +type IconURL struct { + Value string `json:"value"` + IsRelative bool `json:"is_relative"` +} + +const DashboardIconBaseURL = "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/" + +var ErrInvalidIconURL = E.New("invalid icon url") + +// Parse implements strutils.Parser. +func (u *IconURL) Parse(v string) error { + if v == "" { + return ErrInvalidIconURL + } + slashIndex := strings.Index(v, "/") + if slashIndex == -1 { + return ErrInvalidIconURL + } + beforeSlash := v[:slashIndex] + switch beforeSlash { + case "http:", "https:": + u.Value = v + return nil + case "@target": + u.Value = v[slashIndex:] + u.IsRelative = true + return nil + case "png", "svg": // walkXCode Icons + u.Value = DashboardIconBaseURL + v + return nil + default: + return ErrInvalidIconURL + } +} + +func (u *IconURL) String() string { + return u.Value +} diff --git a/internal/net/http/server/server.go b/internal/net/http/server/server.go index ce30d01..6e27a66 100644 --- a/internal/net/http/server/server.go +++ b/internal/net/http/server/server.go @@ -11,6 +11,7 @@ import ( "github.com/rs/zerolog" "github.com/yusing/go-proxy/internal/autocert" + "github.com/yusing/go-proxy/internal/common" "github.com/yusing/go-proxy/internal/logging" "github.com/yusing/go-proxy/internal/task" ) @@ -52,18 +53,23 @@ func NewServer(opt Options) (s *Server) { certAvailable = err == nil } + out := io.Discard + if common.IsDebug { + out = logging.GetLogger() + } + if opt.HTTPAddr != "" { httpSer = &http.Server{ Addr: opt.HTTPAddr, Handler: opt.Handler, - ErrorLog: log.New(io.Discard, "", 0), // most are tls related + ErrorLog: log.New(out, "", 0), // most are tls related } } if certAvailable && opt.HTTPSAddr != "" { httpsSer = &http.Server{ Addr: opt.HTTPSAddr, Handler: opt.Handler, - ErrorLog: log.New(io.Discard, "", 0), // most are tls related + ErrorLog: log.New(out, "", 0), // most are tls related TLSConfig: &tls.Config{ GetCertificate: opt.CertProvider.GetCert, }, diff --git a/internal/route/provider/docker_test.go b/internal/route/provider/docker_test.go index 592927c..dfec243 100644 --- a/internal/route/provider/docker_test.go +++ b/internal/route/provider/docker_test.go @@ -10,6 +10,7 @@ import ( "github.com/yusing/go-proxy/internal/common" D "github.com/yusing/go-proxy/internal/docker" E "github.com/yusing/go-proxy/internal/error" + "github.com/yusing/go-proxy/internal/homepage" "github.com/yusing/go-proxy/internal/route" "github.com/yusing/go-proxy/internal/route/entry" T "github.com/yusing/go-proxy/internal/route/types" @@ -123,7 +124,8 @@ func TestApplyLabel(t *testing.T) { ExpectEqual(t, b.Container.StopSignal, "SIGTERM") ExpectEqual(t, a.Homepage.Show, true) - ExpectEqual(t, a.Homepage.Icon, "png/example.png") + ExpectEqual(t, a.Homepage.Icon.Value, homepage.DashboardIconBaseURL+"png/example.png") + ExpectEqual(t, a.Homepage.Icon.IsRelative, false) ExpectEqual(t, a.HealthCheck.Path, "/ping") ExpectEqual(t, a.HealthCheck.Interval, 10*time.Second) diff --git a/next-release.md b/next-release.md index bf902e9..ae1989a 100644 --- a/next-release.md +++ b/next-release.md @@ -95,15 +95,22 @@ GoDoxy v0.8.2 expected changes do: error 403 Forbidden ``` -```` - -- config reload will now cause all servers to fully restart (i.e. proxy, api, prometheus, etc) -- multiline-string as list now treated as YAML list, which requires hyphen prefix `-`, i.e. +- **new** GoDoxy server side favicon retreiving and caching + - deliver smooth dashboard experience by caching favicons + - correct icon can show without setting `homepage.icon` by parsing it from app's root path "/", selecting `link[rel=icon]` from HTML as default icon +- config reload will now cause a server full restart (i.e. proxy, api, prometheus, etc), eliminating some incorrect behaviors +- drop support of inline yaml string list without hyphen `-` prefix, e.g. ```yaml - proxy.app.middlewares.request.hide_headers: + # old + proxy.app.middlewares.request.hide_headers: | + X-Header1 + X-Header2 + + # new + proxy.app.middlewares.request.hide_headers: | - X-Header1 - X-Header2 -```` + ``` - autocert now supports hot-reload - middleware compose now supports cross-referencing, e.g. ```yaml