Add --fallback option to serve every file, even if no corresponding format is registered

README.md

@@ -106,37 +106,36 @@ Usage:
   roulette <path> [path]... [flags]
 
 Flags:
-  -a, --all                       enable all supported file types
+  -a, --all                  enable all supported file types
-      --audio                     enable support for audio files
+      --audio                enable support for audio files
-  -b, --bind string               address to bind to (default "0.0.0.0")
+  -b, --bind string          address to bind to (default "0.0.0.0")
-      --case-sensitive            use case-sensitive matching for filters
+      --case-sensitive       use case-sensitive matching for filters
-      --code                      enable support for source code files
+      --code                 enable support for source code files
-      --code-theme string         theme for source code syntax highlighting (default "solarized-dark256")
+      --code-theme string    theme for source code syntax highlighting (default "solarized-dark256")
-      --exit-on-error             shut down webserver on error, instead of just printing the error
+      --exit-on-error        shut down webserver on error, instead of just printing the error
-  -f, --filter                    enable filtering
+      --fallback             serve files as application/octet-stream if no matching format is registered
-      --flash                     enable support for shockwave flash files (via ruffle.rs)
+  -f, --filter               enable filtering
-      --handlers                  display registered handlers (for debugging)
+      --flash                enable support for shockwave flash files (via ruffle.rs)
-  -h, --help                      help for roulette
+      --handlers             display registered handlers (for debugging)
-      --images                    enable support for image files
+  -h, --help                 help for roulette
-  -c, --index                     generate index of supported file paths at startup
+      --images               enable support for image files
-      --index-file string         path to optional persistent index file
+      --index                generate index of supported file paths at startup
-  -i, --info                      expose informational endpoints
+      --index-file string    path to optional persistent index file
-      --max-directory-scans int   number of directories to scan at once (default 32)
+  -i, --info                 expose informational endpoints
-      --max-file-count int        skip directories with file counts above this value (default 2147483647)
+      --max-file-count int   skip directories with file counts above this value (default 2147483647)
-      --max-file-scans int        number of files to scan at once (default 256)
+      --min-file-count int   skip directories with file counts below this value (default 1)
-      --min-file-count int        skip directories with file counts below this value (default 1)
+      --page-length int      pagination length for info pages
-      --page-length int           pagination length for info pages
+  -p, --port int             port to listen on (default 8080)
-  -p, --port int                  port to listen on (default 8080)
+      --prefix string        root path for http handlers (for reverse proxying) (default "/")
-      --prefix string             root path for http handlers (for reverse proxying) (default "/")
+      --profile              register net/http/pprof handlers
-      --profile                   register net/http/pprof handlers
+  -r, --recursive            recurse into subdirectories
-  -r, --recursive                 recurse into subdirectories
+      --refresh              enable automatic page refresh via query parameter
-      --refresh                   enable automatic page refresh via query parameter
+      --russian              remove selected images after serving
-      --russian                   remove selected images after serving
+  -s, --sort                 enable sorting
-  -s, --sort                      enable sorting
+      --text                 enable support for text files
-      --text                      enable support for text files
+  -v, --verbose              log accessed files and other information to stdout
-  -v, --verbose                   log accessed files and other information to stdout
+  -V, --version              display version and exit
-  -V, --version                   display version and exit
+      --video                enable support for video files
-      --video                     enable support for video files
 ```
 
 ## Building the Docker container

cmd/errors.go

@@ -19,7 +19,6 @@ var (
 	ErrInvalidFileCountRange = errors.New("maximum file count limit must be greater than or equal to minimum file count limit")
 	ErrInvalidFileCountValue = errors.New("file count limits must be positive integers no greater than 2147483647")
 	ErrInvalidPort           = errors.New("listen port must be an integer between 1 and 65535 inclusive")
-	ErrInvalidScanCount      = errors.New("maximum scan count must be a positive integer no greater than 2147483647")
 	ErrNoMediaFound          = errors.New("no supported media formats found which match all criteria")
 )
 

cmd/files.go

@@ -226,15 +226,20 @@ func hasSupportedFiles(path string, formats *types.Types) (bool, error) {
 	}
 }
 
-func pathCount(path string) (int, int, error) {
+func walkPath(path string, fileChannel chan<- string, stats *scanStatsChannels, formats *types.Types) error {
-	var directories = 0
+	var wg sync.WaitGroup
-	var files = 0
+
+	errorChannel := make(chan error)
+	done := make(chan bool, 1)
 
 	nodes, err := os.ReadDir(path)
 	if err != nil {
-		return 0, 0, err
+		return err
 	}
 
+	var directories = 0
+	var files = 0
+
 	for _, node := range nodes {
 		if node.IsDir() {
 			directories++
@@ -243,65 +248,61 @@ func pathCount(path string) (int, int, error) {
 		}
 	}
 
-	return files, directories, nil
+	var skipFiles = false
-}
 
-func walkPath(path string, fileChannel chan<- string, fileScans chan int, stats *scanStatsChannels, formats *types.Types) error {
+	if files <= MaxFileCount && files >= MinFileCount {
-	var wg sync.WaitGroup
+		stats.directoriesMatched <- 1
+	} else {
+		stats.filesSkipped <- files
+		stats.directoriesSkipped <- 1
 
-	errorChannel := make(chan error)
+		skipFiles = true
-	done := make(chan bool, 1)
+	}
+
+	for _, node := range nodes {
+		fullPath := filepath.Join(path, node.Name())
 
-	filepath.WalkDir(path, func(p string, info os.DirEntry, err error) error {
 		switch {
-		case !Recursive && info.IsDir() && p != path:
+		case node.IsDir() && Recursive:
-			return filepath.SkipDir
-		case !info.IsDir():
 			wg.Add(1)
-			fileScans <- 1
 
 			go func() {
 				defer func() {
 					wg.Done()
-					<-fileScans
 				}()
+				err := walkPath(fullPath, fileChannel, stats, formats)
+				if err != nil {
+					errorChannel <- err
 
-				path, err := normalizePath(p)
+					return
+				}
+			}()
+		case !node.IsDir() && !skipFiles:
+			wg.Add(1)
+
+			go func() {
+				defer func() {
+					wg.Done()
+				}()
+				path, err := normalizePath(fullPath)
 				if err != nil {
 					errorChannel <- err
 
 					return
 				}
 
-				if !formats.Validate(path) {
+				if formats.Validate(path) || Fallback {
-					stats.filesSkipped <- 1
+					fileChannel <- path
+
+					stats.filesMatched <- 1
 
 					return
 				}
 
-				fileChannel <- path
+				stats.filesSkipped <- 1
-
-				stats.filesMatched <- 1
 			}()
-		case info.IsDir():
-			files, directories, err := pathCount(p)
-			if err != nil {
-				errorChannel <- err
-			}
-
-			if files > 0 && (files < MinFileCount) || (files > MaxFileCount) {
-				// This count will not otherwise include the parent directory itself, so increment by one
-				stats.directoriesSkipped <- directories + 1
-				stats.filesSkipped <- files
-
-				return filepath.SkipDir
-			}
-
-			stats.directoriesMatched <- 1
 		}
-
+	}
-		return nil
-	})
 
 	go func() {
 		wg.Wait()
@@ -311,8 +312,8 @@ func walkPath(path string, fileChannel chan<- string, fileScans chan int, stats
 Poll:
 	for {
 		select {
-		case e := <-errorChannel:
+		case err := <-errorChannel:
-			return e
+			return err
 		case <-done:
 			break Poll
 		}
@@ -326,8 +327,6 @@ func scanPaths(paths []string, sort string, index *fileIndex, formats *types.Typ
 
 	fileChannel := make(chan string)
 	errorChannel := make(chan error)
-	directoryScans := make(chan int, MaxDirScans)
-	fileScans := make(chan int, MaxFileScans)
 	done := make(chan bool, 1)
 
 	stats := &scanStats{
@@ -350,15 +349,13 @@ func scanPaths(paths []string, sort string, index *fileIndex, formats *types.Typ
 
 	for i := 0; i < len(paths); i++ {
 		wg.Add(1)
-		directoryScans <- 1
 
 		go func(i int) {
 			defer func() {
 				wg.Done()
-				<-directoryScans
 			}()
+			err := walkPath(paths[i], fileChannel, statsChannels, formats)
 
-			err := walkPath(paths[i], fileChannel, fileScans, statsChannels, formats)
 			if err != nil {
 				errorChannel <- err
 

cmd/root.go

@@ -12,7 +12,7 @@ import (
 )
 
 const (
-	ReleaseVersion string = "2.1.1"
+	ReleaseVersion string = "2.3.0"
 )
 
 var (
@@ -23,6 +23,7 @@ var (
 	Code          bool
 	CodeTheme     string
 	ExitOnError   bool
+	Fallback      bool
 	Filtering     bool
 	Flash         bool
 	Handlers      bool
@@ -30,8 +31,6 @@ var (
 	Index         bool
 	IndexFile     string
 	Info          bool
-	MaxDirScans   int
-	MaxFileScans  int
 	MaxFileCount  int
 	MinFileCount  int
 	PageLength    int
@@ -53,8 +52,6 @@ var (
 		Args:  cobra.MinimumNArgs(1),
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			switch {
-			case MaxDirScans < 1 || MaxFileScans < 1 || MaxDirScans > math.MaxInt32 || MaxFileScans > math.MaxInt32:
-				return ErrInvalidScanCount
 			case MaxFileCount < 1 || MinFileCount < 1 || MaxFileCount > math.MaxInt32 || MinFileCount > math.MaxInt32:
 				return ErrInvalidFileCountValue
 			case MinFileCount > MaxFileCount:
@@ -91,6 +88,7 @@ func init() {
 	rootCmd.Flags().BoolVar(&Code, "code", false, "enable support for source code files")
 	rootCmd.Flags().StringVar(&CodeTheme, "code-theme", "solarized-dark256", "theme for source code syntax highlighting")
 	rootCmd.Flags().BoolVar(&ExitOnError, "exit-on-error", false, "shut down webserver on error, instead of just printing the error")
+	rootCmd.Flags().BoolVar(&Fallback, "fallback", false, "serve files as application/octet-stream if no matching format is registered")
 	rootCmd.Flags().BoolVarP(&Filtering, "filter", "f", false, "enable filtering")
 	rootCmd.Flags().BoolVar(&Flash, "flash", false, "enable support for shockwave flash files (via ruffle.rs)")
 	rootCmd.Flags().BoolVar(&Handlers, "handlers", false, "display registered handlers (for debugging)")
@@ -98,8 +96,6 @@ func init() {
 	rootCmd.Flags().BoolVar(&Index, "index", false, "generate index of supported file paths at startup")
 	rootCmd.Flags().StringVar(&IndexFile, "index-file", "", "path to optional persistent index file")
 	rootCmd.Flags().BoolVarP(&Info, "info", "i", false, "expose informational endpoints")
-	rootCmd.Flags().IntVar(&MaxDirScans, "max-directory-scans", 32, "number of directories to scan at once")
-	rootCmd.Flags().IntVar(&MaxFileScans, "max-file-scans", 256, "number of files to scan at once")
 	rootCmd.Flags().IntVar(&MaxFileCount, "max-file-count", math.MaxInt32, "skip directories with file counts above this value")
 	rootCmd.Flags().IntVar(&MinFileCount, "min-file-count", 1, "skip directories with file counts below this value")
 	rootCmd.Flags().IntVar(&PageLength, "page-length", 0, "pagination length for info pages")

cmd/web.go

@@ -41,12 +41,12 @@ const (
 	timeout            time.Duration = 10 * time.Second
 )
 
-func preparePath(path string) string {
+func preparePath(prefix, path string) string {
 	if runtime.GOOS == "windows" {
-		return fmt.Sprintf("%s/%s", mediaPrefix, filepath.ToSlash(path))
+		return fmt.Sprintf("%s/%s", prefix, filepath.ToSlash(path))
 	}
 
-	return mediaPrefix + path
+	return prefix + path
 }
 
 func serveStaticFile(paths []string, index *fileIndex, errorChannel chan<- error) httprouter.Handle {
@@ -228,7 +228,7 @@ func serveRoot(paths []string, regexes *regexes, index *fileIndex, formats *type
 		newUrl := fmt.Sprintf("http://%s%s%s%s",
 			r.Host,
 			Prefix,
-			preparePath(path),
+			preparePath(mediaPrefix, path),
 			queryParams,
 		)
 		http.Redirect(w, r, newUrl, redirectStatusCode)
@@ -266,9 +266,28 @@ func serveMedia(paths []string, regexes *regexes, index *fileIndex, formats *typ
 
 		format := formats.FileType(path)
 		if format == nil {
-			serverError(w, r, nil)
+			if Fallback {
+				w.Header().Add("Content-Type", "application/octet-stream")
 
-			return
+				_, refreshInterval := refreshInterval(r)
+
+				// redirect to static url for file
+				newUrl := fmt.Sprintf("http://%s%s%s%s",
+					r.Host,
+					Prefix,
+					preparePath(sourcePrefix, path),
+					generateQueryParams(filters, sortOrder, refreshInterval),
+				)
+
+				http.Redirect(w, r, newUrl, redirectStatusCode)
+
+				return
+			} else {
+				notFound(w, r, path)
+
+				return
+
+			}
 		}
 
 		if !format.Validate(path) {