Compare commits

...

3 Commits

Author SHA1 Message Date
Seednode 6b70741a68 Replace --refresh-interval flag with --refresh 2023-09-14 00:07:54 -05:00
Seednode 0e7cb2bb36 Updated readme with new usage info for --refresh-interval 2023-09-14 00:05:31 -05:00
Seednode 99ec1d7ebd Allow toggling of page refreshInterval 2023-09-14 00:01:50 -05:00
4 changed files with 52 additions and 57 deletions

View File

@ -58,7 +58,7 @@ The remaining four endpoints—`/available_extensions`, `/enabled_extensions`, `
## Refresh
If a positive-value `refresh=<integer><unit>` query parameter is provided, the page will reload after that interval.
If the `--refresh` flag is passed and a positive-value `refresh=<integer><unit>` query parameter is provided, the page will reload after that interval.
This can be used to generate a sort of slideshow of files.
@ -107,31 +107,31 @@ Usage:
roulette <path> [path]... [flags]
Flags:
-a, --all enable all supported file types
--audio enable support for audio files
-b, --bind string address to bind to (default "0.0.0.0")
-c, --cache generate directory cache at startup
--cache-file string path to optional persistent cache file
-f, --filter enable filtering
--flash enable support for shockwave flash files (via ruffle.rs)
--handlers display registered handlers (for debugging)
-h, --help help for roulette
--images enable support for image files
-i, --info expose informational endpoints
--maximum-files uint32 skip directories with file counts above this value (default 4294967295)
--minimum-files uint32 skip directories with file counts below this value (default 1)
--page-length uint32 pagination length for statistics and debug pages
-p, --port uint16 port to listen on (default 8080)
--prefix string path with which to prefix all listeners (for reverse proxying)
--profile register net/http/pprof handlers
-r, --recursive recurse into subdirectories
--refresh-interval string force refresh interval equal to this duration (minimum 500ms)
--russian remove selected images after serving
-s, --sort enable sorting
--text enable support for text files
-v, --verbose log accessed files and other information to stdout
-V, --version display version and exit
--video enable support for video files
-a, --all enable all supported file types
--audio enable support for audio files
-b, --bind string address to bind to (default "0.0.0.0")
-c, --cache generate directory cache at startup
--cache-file string path to optional persistent cache file
-f, --filter enable filtering
--flash enable support for shockwave flash files (via ruffle.rs)
--handlers display registered handlers (for debugging)
-h, --help help for roulette
--images enable support for image files
-i, --info expose informational endpoints
--maximum-files uint32 skip directories with file counts above this value (default 4294967295)
--minimum-files uint32 skip directories with file counts below this value (default 1)
--page-length uint32 pagination length for statistics and debug pages
-p, --port uint16 port to listen on (default 8080)
--prefix string root path for http handlers (for reverse proxying) (default "/")
--profile register net/http/pprof handlers
-r, --recursive recurse into subdirectories
--refresh enable automatic page refresh via query parameter
--russian remove selected images after serving
-s, --sort enable sorting
--text enable support for text files
-v, --verbose log accessed files and other information to stdout
-V, --version display version and exit
--video enable support for video files
```
## Building the Docker container

View File

@ -6,13 +6,12 @@ package cmd
import (
"log"
"time"
"github.com/spf13/cobra"
)
const (
ReleaseVersion string = "0.82.0"
ReleaseVersion string = "0.83.0"
)
var (
@ -33,7 +32,7 @@ var (
Prefix string
Profile bool
Recursive bool
RefreshInterval string
Refresh bool
Russian bool
Sorting bool
Text bool
@ -45,16 +44,6 @@ var (
Use: "roulette <path> [path]...",
Short: "Serves random media from the specified directories.",
Args: cobra.MinimumNArgs(1),
PreRunE: func(cmd *cobra.Command, args []string) error {
if RefreshInterval != "" {
interval, err := time.ParseDuration(RefreshInterval)
if err != nil || interval < 500*time.Millisecond {
return ErrIncorrectRefreshInterval
}
}
return nil
},
RunE: func(cmd *cobra.Command, args []string) error {
err := ServePage(args)
if err != nil {
@ -88,10 +77,10 @@ func init() {
rootCmd.Flags().Uint32Var(&MinimumFileCount, "minimum-files", 1, "skip directories with file counts below this value")
rootCmd.Flags().Uint32Var(&PageLength, "page-length", 0, "pagination length for statistics and debug pages")
rootCmd.Flags().Uint16VarP(&Port, "port", "p", 8080, "port to listen on")
rootCmd.Flags().StringVar(&Prefix, "prefix", "", "path with which to prefix all listeners (for reverse proxying)")
rootCmd.Flags().StringVar(&Prefix, "prefix", "/", "root path for http handlers (for reverse proxying)")
rootCmd.Flags().BoolVar(&Profile, "profile", false, "register net/http/pprof handlers")
rootCmd.Flags().BoolVarP(&Recursive, "recursive", "r", false, "recurse into subdirectories")
rootCmd.Flags().StringVar(&RefreshInterval, "refresh-interval", "", "force refresh interval equal to this duration (minimum 500ms)")
rootCmd.Flags().BoolVar(&Refresh, "refresh", false, "enable automatic page refresh via query parameter")
rootCmd.Flags().BoolVar(&Russian, "russian", false, "remove selected images after serving")
rootCmd.Flags().BoolVarP(&Sorting, "sort", "s", false, "enable sorting")
rootCmd.Flags().BoolVar(&Text, "text", false, "enable support for text files")

View File

@ -14,18 +14,12 @@ import (
)
func refreshInterval(r *http.Request) (int64, string) {
var interval string
if RefreshInterval == "" {
interval = r.URL.Query().Get("refresh")
} else {
interval = RefreshInterval
}
interval := r.URL.Query().Get("refresh")
duration, err := time.ParseDuration(interval)
switch {
case err != nil || duration == 0:
case err != nil || duration == 0 || !Refresh:
return 0, "0ms"
case duration < 500*time.Millisecond:
return 500, "500ms"
@ -92,12 +86,20 @@ func generateQueryParams(filters *filters, sortOrder, refreshInterval string) st
hasParams = true
}
if hasParams {
queryParams.WriteString("&")
}
queryParams.WriteString(fmt.Sprintf("refresh=%s", refreshInterval))
if Refresh {
if hasParams {
queryParams.WriteString("&")
}
queryParams.WriteString(fmt.Sprintf("refresh=%s", refreshInterval))
return queryParams.String()
hasParams = true
}
if hasParams {
return queryParams.String()
}
return ""
}
func stripQueryParams(request string) (string, error) {

View File

@ -243,7 +243,7 @@ func serveMedia(paths []string, regexes *regexes, formats *types.Types) httprout
return
}
fileUri := Prefix + "/" + generateFileUri(path)
fileUri := Prefix + generateFileUri(path)
fileName := filepath.Base(path)
@ -385,9 +385,13 @@ func ServePage(args []string) error {
mux.PanicHandler = serverErrorHandler()
Prefix = strings.TrimSuffix(Prefix, "/")
if !strings.HasSuffix(Prefix, "/") {
Prefix = Prefix + "/"
}
register(mux, Prefix+"/", serveRoot(paths, regexes, cache, formats))
register(mux, Prefix, serveRoot(paths, regexes, cache, formats))
Prefix = strings.TrimSuffix(Prefix, "/")
if Prefix != "" {
register(mux, "/", redirectRoot())