Merge branch 'develop'

.github/workflows/docker.yml

@@ -11,32 +11,32 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Docker meta
         id: meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
         with:
           images: |
             ghcr.io/royxiang/plexproxy
           tags: |
             type=semver,pattern={{version}}
       -
         name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
       -
         name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
       -
         name: Login to GitHub Container Registry
-        uses: docker/#-action@v2
+        uses: docker/#-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
       -
         name: Build and push
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v6
         with:
           build-args: |
             VERSION=${{ github.ref_name }}

.github/workflows/goreleaser.yml

@@ -14,20 +14,20 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
       -
         name: Set up Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v5
         with:
-          go-version: 1.17
+          go-version: 1.21
       -
         name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v3
+        uses: goreleaser/goreleaser-action@v6
         with:
           distribution: goreleaser
-          version: latest
-          args: release --rm-dist
+          version: '~> v1'
+          args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.goreleaser.yml

@@ -20,4 +20,5 @@ changelog:
     exclude:
       - "^build\\(deps\\)"
       - "^Merge branch"
+      - "^Merge pull request"
       - "^Revert"

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.17 AS builder
+FROM golang:1.21 AS builder
 
 ARG VERSION
 

README.md

@@ -28,15 +28,13 @@ env CGO_ENABLED=0 go install -trimpath -ldflags="-s -w" github.com/RoyXiang/plex
 
 1. Configure environment variables in your preferred way
    - `PLEX_BASEURL` (Required, e.g. `http://127.0.0.1:32400`)
-   - `REDIS_URL` (Optional, e.g. `redis://127.0.0.1:6379`)
-       * If you need a cache layer, set a value for it
    - `PLAXT_URL` (Optional, e.g. `https://plaxt.astandke.com/api?id=generate-your-own-silly`)
      * `PLEX_TOKEN` is required
      * Set it if you run an instance of [Plaxt](https://github.com/XanderStrike/goplaxt)
      * Or, you can set it to [the official one](https://plaxt.astandke.com/)
    - `PLEX_TOKEN` (Optional, if you need it, see [here](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/))
-   - `STATIC_CACHE_TTL` (Optional, default: `1h`, which controls the cache TTL of static files)
-   - `DYNAMIC_CACHE_TTL` (Optional, default: `1s`, which controls the cache TTL of dynamic requests)
+   - `STATIC_CACHE_SIZE` (Optional, the cache size of static files, e.g. CSS files, images, default: `1000`)
+   - `STATIC_CACHE_TTL` (Optional, the cache TTL of static files, default: `72h`)
    - `REDIRECT_WEB_APP` (Optional, default: `true`)
    - `DISABLE_TRANSCODE` (Optional, default: `true`)
    - `NO_REQUEST_LOGS` (Optional, default: `false`)

go.mod

@@ -1,22 +1,20 @@
 module github.com/RoyXiang/plexproxy
 
-go 1.17
+go 1.21
 
 require (
-	github.com/go-chi/chi/v5 v5.0.7
-	github.com/go-redis/redis/v8 v8.11.5
-	github.com/gorilla/handlers v1.5.1
-	github.com/gorilla/mux v1.8.0
+	github.com/bluele/gcache v0.0.2
+	github.com/go-chi/chi/v5 v5.1.0
+	github.com/gorilla/mux v1.8.1
 	github.com/jrudio/go-plex-client v0.0.0-20220106065909-9e1d590b99aa
 	github.com/xanderstrike/plexhooks v0.0.0-20200926011736-c63bcd35fe3e
 )
 
 require (
-	github.com/cespare/xxhash/v2 v2.1.2 // indirect
-	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
-	github.com/felixge/httpsnoop v1.0.1 // indirect
 	github.com/google/uuid v1.3.0 // indirect
 	github.com/gorilla/websocket v1.5.0 // indirect
+	github.com/onsi/ginkgo v1.16.5 // indirect
+	github.com/onsi/gomega v1.18.1 // indirect
 )
 
 replace github.com/jrudio/go-plex-client v0.0.0-20220106065909-9e1d590b99aa => github.com/RoyXiang/go-plex-client v0.0.0-20220313053419-e24ff7ada173

go.sum

@@ -4,11 +4,10 @@ github.com/OneOfOne/xxhash v1.2.2/go.mod h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAE
 github.com/RoyXiang/go-plex-client v0.0.0-20220313053419-e24ff7ada173 h1:/GJ+g7nvyg3HjY+J4p5Ag+TUoWjIrJxpHWzdbA4Phzw=
 github.com/RoyXiang/go-plex-client v0.0.0-20220313053419-e24ff7ada173/go.mod h1:twidbPLE4eUk3CgDno5uCzpnPRboBTElH+iJrQO7S4w=
 github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8=
-github.com/cespare/xxhash v1.1.0 h1:a6HrQnmkObjyL+Gs60czilIUGqrzKutQD6XZog3p+ko=
+github.com/bluele/gcache v0.0.2 h1:WcbfdXICg7G/DGBh1PFfcirkWOQV+v077yF1pSy3DGw=
+github.com/bluele/gcache v0.0.2/go.mod h1:m15KV+ECjptwSPxKhOhQoAFQVtUFjTVkc3H8o0t/fp0=
 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 h1:YRXhKfTDauu4ajMg1TPgFO5jnlC2HCbmLXMcTG5cbYE=
-github.com/cespare/xxhash/v2 v2.1.2/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
 github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI=
 github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI=
 github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU=
@@ -22,18 +21,12 @@ github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs
 github.com/dgraph-io/badger/v3 v3.2103.2/go.mod h1:RHo4/GmYcKKh5Lxu63wLEMHJ70Pac2JqZRYGhlyAo2M=
 github.com/dgraph-io/ristretto v0.1.0/go.mod h1:fux0lOrBhrVCJd3lcTHsIJhq1T2rokOu6v9Vcb3Q9ug=
 github.com/dgryski/go-farm v0.0.0-20190423205320-6a90982ecee2/go.mod h1:SqUrOPUnsFjfmXRMNPybcSiG0BgUW2AuFH8PAnS2iTw=
-github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78=
-github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc=
 github.com/dustin/go-humanize v1.0.0/go.mod h1:HtrtbFcZ19U5GC7JDqmcUSB87Iq5E25KnS6fMYU6eOk=
-github.com/felixge/httpsnoop v1.0.1 h1:lvB5Jl89CsZtGIWuTcDM1E/vkVs49/Ml7JJe07l8SPQ=
-github.com/felixge/httpsnoop v1.0.1/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
 github.com/fsnotify/fsnotify v1.4.9 h1:hsms1Qyu0jgnwNXIxa+/V/PDsU6CfLf6CNO8H7IWoS4=
 github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ=
-github.com/go-chi/chi/v5 v5.0.7 h1:rDTPXLDHGATaeHvVlLcR4Qe0zftYethFucbjVQ1PxU8=
-github.com/go-chi/chi/v5 v5.0.7/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
-github.com/go-redis/redis/v8 v8.11.5 h1:AcZZR7igkdvfVmQTPnu9WE37LRrO/YrBH5zWyjDC0oI=
-github.com/go-redis/redis/v8 v8.11.5/go.mod h1:gREzHqY1hg6oD9ngVRbLStwAWKhA0FEgq8Jd4h5lpwo=
+github.com/go-chi/chi/v5 v5.1.0 h1:acVI1TYaD+hhedDJ3r54HyA6sExp3HfXq7QWEEY/xMw=
+github.com/go-chi/chi/v5 v5.1.0/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
 github.com/go-task/slim-sprig v0.0.0-20210107165309-348f09dbbbc0/go.mod h1:fyg7847qk6SyHyPtNmDHnmrv/HOrqktSC+C9fM+CJOE=
 github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=
 github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
@@ -59,10 +52,8 @@ github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
 github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE=
 github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/gorilla/handlers v1.5.1 h1:9lRY6j8DEeeBT10CvO9hGW0gmky0BprnvDI5vfhUHH4=
-github.com/gorilla/handlers v1.5.1/go.mod h1:t8XrUpc4KVXb7HGyJ4/cEnwQiaxrX/hz1Zv/4g96P1Q=
-github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
-github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
+github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY=
+github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ=
 github.com/gorilla/websocket v1.5.0 h1:PPwGk2jz7EePpoHN/+ClbZu8SPxiqlu12wZP/3sWmnc=
 github.com/gorilla/websocket v1.5.0/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
 github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=

handler/const.go

@@ -9,12 +9,19 @@ const (
 	headerPageStart      = "X-Plex-Container-Start"
 	headerToken          = "X-Plex-Token"
 	headerUserId         = "X-Plex-User-Id"
+
 	headerAccept         = "Accept"
 	headerAcceptLanguage = "Accept-Language"
 	headerCacheControl   = "Cache-Control"
 	headerContentType    = "Content-Type"
 	headerRange          = "Range"
 	headerVary           = "Vary"
+	headerUpgrade        = "Upgrade"
+
+	headerForwardedFor    = "X-Forwarded-For"
+	headerRealIP          = "X-Real-IP"
+	headerForwardedProto  = "X-Forwarded-Proto"
+	headerForwardedScheme = "X-Forwarded-Scheme"
 
 	cachePrefixDynamic = "dynamic"
 	cachePrefixStatic  = "static"

handler/main.go

@@ -6,14 +6,11 @@ import (
 	"os"
 
 	"github.com/go-chi/chi/v5/middleware"
-	"github.com/go-redis/redis/v8"
-	"github.com/gorilla/handlers"
 	"github.com/gorilla/mux"
 )
 
 var (
-	plexClient  *PlexClient
-	redisClient *redis.Client
+	plexClient *PlexClient
 
 	emptyStruct = struct{}{}
 )
@@ -23,51 +20,37 @@ func init() {
 		BaseUrl:          os.Getenv("PLEX_BASEURL"),
 		Token:            os.Getenv("PLEX_TOKEN"),
 		PlaxtUrl:         os.Getenv("PLAXT_URL"),
+		StaticCacheSize:  os.Getenv("STATIC_CACHE_SIZE"),
 		StaticCacheTtl:   os.Getenv("STATIC_CACHE_TTL"),
-		DynamicCacheTtl:  os.Getenv("DYNAMIC_CACHE_TTL"),
 		RedirectWebApp:   os.Getenv("REDIRECT_WEB_APP"),
 		DisableTranscode: os.Getenv("DISABLE_TRANSCODE"),
 		NoRequestLogs:    os.Getenv("NO_REQUEST_LOGS"),
 	})
 	if plexClient == nil {
 		log.Fatalln("Please configure PLEX_BASEURL as a valid URL at first")
 	}
-
-	redisUrl := os.Getenv("REDIS_URL")
-	if redisUrl != "" {
-		options, err := redis.ParseURL(redisUrl)
-		if err == nil {
-			redisClient = redis.NewClient(options)
-		}
-	}
 }
 
 func NewRouter() http.Handler {
 	r := mux.NewRouter()
-	r.Use(handlers.ProxyHeaders, normalizeMiddleware)
+	r.Use(normalizeMiddleware)
 	if !plexClient.NoRequestLogs {
 		r.Use(middleware.Logger)
 	}
 	r.Use(wrapMiddleware, middleware.Recoverer, trafficMiddleware)
 
-	if redisClient != nil {
-		// bypass cache
-		r.PathPrefix("/:/").Handler(plexClient)
-		r.PathPrefix("/library/parts/").Handler(plexClient)
-
-		staticRouter := r.Methods(http.MethodGet).Subrouter()
-		staticRouter.Use(staticMiddleware)
-		staticRouter.Path("/library/media/{key}/chapterImages/{id}").Handler(plexClient)
-		staticRouter.Path("/library/metadata/{key}/art/{id}").Handler(plexClient)
-		staticRouter.Path("/library/metadata/{key}/thumb/{id}").Handler(plexClient)
-		staticRouter.Path("/photo/:/transcode").Handler(plexClient)
-		staticRouter.PathPrefix("/web/js/").Handler(plexClient)
-		staticRouter.PathPrefix("/web/static/").Handler(plexClient)
-
-		dynamicRouter := r.Methods(http.MethodGet).Subrouter()
-		dynamicRouter.Use(dynamicMiddleware)
-		dynamicRouter.PathPrefix("/").Handler(plexClient)
-	}
+	staticRouter := r.Methods(http.MethodGet).Subrouter()
+	staticRouter.Use(staticMiddleware)
+	staticRouter.Path("/library/media/{key}/chapterImages/{id}").Handler(plexClient)
+	staticRouter.Path("/library/metadata/{key}/art/{id}").Handler(plexClient)
+	staticRouter.Path("/library/metadata/{key}/thumb/{id}").Handler(plexClient)
+	staticRouter.Path("/photo/:/transcode").Handler(plexClient)
+	staticRouter.PathPrefix("/web/js/").Handler(plexClient)
+	staticRouter.PathPrefix("/web/static/").Handler(plexClient)
+
+	dynamicRouter := r.Methods(http.MethodGet).Subrouter()
+	dynamicRouter.Use(dynamicMiddleware)
+	dynamicRouter.PathPrefix("/").Handler(plexClient)
 
 	r.PathPrefix("/").Handler(plexClient)
 	return r