Add abillity to set path prefix

README.md

@@ -78,100 +78,103 @@ Sometimes this is just a more practical and quick way than doing things properly
 
 ## Usage
 
-    miniserve 0.15.0
+    miniserve 0.15.1-alpha.0
     Sven-Hendrik Haase <svenstaro@gmail.com>, Boastful Squirrel <boastful.squirrel@gmail.com>
     For when you really just want to serve some files over HTTP right now!
-
+    
     USAGE:
         miniserve [FLAGS] [OPTIONS] [--] [PATH]
-
+    
     FLAGS:
-        -D, --dirs-first
-                List directories first
-
-        -r, --enable-tar
-                Enable uncompressed tar archive generation
-
-        -g, --enable-tar-gz
-                Enable gz-compressed tar archive generation
-
-        -z, --enable-zip
-                Enable zip archive generation
-
-                WARNING: Zipping large directories can result in out-of-memory exception because zip generation is done in
-                memory and cannot be sent on the fly
-        -u, --upload-files
-                Enable file uploading
-
-        -h, --help
-                Prints help information
-
-        -H, --hidden
-                Show hidden files
-
-        -F, --hide-version-footer
-                Hide version footer
-
-        -P, --no-symlinks
-                Do not follow symbolic links
-
-        -o, --overwrite-files
-                Enable overriding existing files during file upload
-
-        -q, --qrcode
-                Enable QR code display
-
-            --random-route
-                Generate a random 6-hexdigit route
-
-        -V, --version
-                Prints version information
-
-        -v, --verbose
-                Be verbose, includes emitting access logs
-
-
+        -D, --dirs-first             
+    	    List directories first
+    
+        -r, --enable-tar             
+    	    Enable uncompressed tar archive generation
+    
+        -g, --enable-tar-gz          
+    	    Enable gz-compressed tar archive generation
+    
+        -z, --enable-zip             
+    	    Enable zip archive generation
+    	    
+    	    WARNING: Zipping large directories can result in out-of-memory exception because zip generation is done in
+    	    memory and cannot be sent on the fly
+        -u, --upload-files           
+    	    Enable file uploading
+    
+        -h, --help                   
+    	    Prints help information
+    
+        -H, --hidden                 
+    	    Show hidden files
+    
+        -F, --hide-version-footer    
+    	    Hide version footer
+    
+        -P, --no-symlinks            
+    	    Do not follow symbolic links
+    
+        -o, --overwrite-files        
+    	    Enable overriding existing files during file upload
+    
+        -q, --qrcode                 
+    	    Enable QR code display
+    
+    	--random-path-prefix     
+    	    Use a random path prefix
+    
+        -V, --version                
+    	    Prints version information
+    
+        -v, --verbose                
+    	    Be verbose, includes emitting access logs
+    
+    
     OPTIONS:
         -a, --auth <auth>...
-                Set authentication. Currently supported formats: username:password, username:sha256:hash,
-                username:sha512:hash (e.g. joe:123,
-                joe:sha256:a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3)
+    	    Set authentication. Currently supported formats: username:password, username:sha256:hash,
+    	    username:sha512:hash (e.g. joe:123,
+    	    joe:sha256:a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3)
         -c, --color-scheme <color-scheme>
-                Default color scheme [default: squirrel]  [possible values: squirrel, archlinux,
-                zenburn, monokai]
+    	    Default color scheme [default: squirrel]  [possible values: squirrel, archlinux,
+    	    zenburn, monokai]
         -d, --color-scheme-dark <color-scheme-dark>
-                Default color scheme [default: archlinux]  [possible values: squirrel, archlinux,
-                zenburn, monokai]
-            --header <header>...
-                Set custom header for responses
-
-            --index <index_file>
-                The name of a directory index file to serve, like "index.html"
-
-                Normally, when miniserve serves a directory, it creates a listing for that directory. However, if a
-                directory contains this file, miniserve will serve that file instead.
-        -i, --interfaces <interfaces>...
-                Interface to listen on
-
-        -p, --port <port>
-                Port to use [default: 8080]
-
-            --print-completions <shell>
-                Generate completion file for a shell [possible values: zsh, bash, fish,
-                powershell, elvish]
-        -t, --title <title>
-                Shown instead of host in page title and heading
-
-            --tls-cert <tls-cert>
-                TLS certificate to use
-
-            --tls-key <tls-key>
-                TLS private key to use
-
-
+    	    Default color scheme [default: archlinux]  [possible values: squirrel, archlinux,
+    	    zenburn, monokai]
+    	--header <header>...                       
+    	    Set custom header for responses
+
+    	--index <index_file>                       
+    	    The name of a directory index file to serve, like "index.html"
+
+    	    Normally, when miniserve serves a directory, it creates a listing for that directory. However, if a
+    	    directory contains this file, miniserve will serve that file instead.
+        -i, --interfaces <interfaces>...               
+    	    Interface to listen on
+
+    	--path-prefix <path-prefix>                
+    	    Use a specific path prefix
+
+        -p, --port <port>                              
+    	    Port to use [default: 8080]
+
+    	--print-completions <shell>
+    	    Generate completion file for a shell [possible values: zsh, bash, fish,
+    	    powershell, elvish]
+        -t, --title <title>                            
+    	    Shown instead of host in page title and heading
+
+    	--tls-cert <tls-cert>                      
+    	    TLS certificate to use
+
+    	--tls-key <tls-key>                        
+    	    TLS private key to use
+
+
     ARGS:
-        <PATH>
-                Which path to serve
+        <PATH>    
+    	    Which path to serve
 
 ## How to install
 

src/args.rs

@@ -55,9 +55,13 @@ pub struct CliArgs {
     )]
     pub auth: Vec<auth::RequiredAuth>,
 
-    /// Generate a random 6-hexdigit route
-    #[structopt(long = "random-route")]
-    pub random_route: bool,
+    /// Use a specific path prefix
+    #[structopt(long = "path-prefix")]
+    pub path_prefix: Option<String>,
+
+    /// Use a random path prefix
+    #[structopt(long = "random-path-prefix", conflicts_with("path-prefix"))]
+    pub random_path_prefix: bool,
 
     /// Do not follow symbolic links
     #[structopt(short = "P", long = "no-symlinks")]

src/auth.rs

@@ -109,8 +109,8 @@ fn build_unauthorized_response(
     if log_error_chain {
         errors::log_error_chain(error.to_string());
     }
-    let return_path = match state.random_route {
-        Some(ref random_route) => format!("/{}", random_route),
+    let return_path = match state.path_prefix {
+        Some(ref path_prefix) => format!("/{}", path_prefix),
         None => "/".to_string(),
     };
 

src/config.rs

@@ -43,8 +43,11 @@ pub struct MiniserveConfig {
     /// Show hidden files
     pub show_hidden: bool,
 
-    /// Enable random route generation
-    pub random_route: Option<String>,
+    /// Use a specific path prefix
+    pub path_prefix: Option<String>,
+
+    /// Use a random path prefix
+    pub random_path_prefix: bool,
 
     /// Randomly generated favicon route
     pub favicon_route: String,
@@ -110,7 +113,9 @@ impl MiniserveConfig {
             ]
         };
 
-        let random_route = if args.random_route {
+        let path_prefix = if let Some(path_prefix) = args.path_prefix {
+            Some(path_prefix)
+        } else if args.random_path_prefix {
             Some(nanoid::nanoid!(6, &ROUTE_ALPHABET))
         } else {
             None
@@ -159,7 +164,8 @@ impl MiniserveConfig {
             path_explicitly_chosen,
             no_symlinks: args.no_symlinks,
             show_hidden: args.hidden,
-            random_route,
+            path_prefix,
+            random_path_prefix: args.random_path_prefix,
             favicon_route,
             css_route,
             default_color_scheme,

src/file_upload.rs

@@ -107,7 +107,7 @@ fn handle_multipart(
 pub fn upload_file(
     req: HttpRequest,
     payload: actix_web::web::Payload,
-    uses_random_route: bool,
+    uses_path_prefix: bool,
     favicon_route: String,
     css_route: String,
     default_color_scheme: &str,
@@ -137,7 +137,7 @@ pub fn upload_file(
                 &return_path,
                 query_params.sort,
                 query_params.order,
-                uses_random_route,
+                uses_path_prefix,
                 &favicon_route,
                 &css_route,
                 default_color_scheme,
@@ -160,7 +160,7 @@ pub fn upload_file(
                 &return_path,
                 query_params.sort,
                 query_params.order,
-                uses_random_route,
+                uses_path_prefix,
                 &favicon_route,
                 &css_route,
                 default_color_scheme,
@@ -183,7 +183,7 @@ pub fn upload_file(
                 &return_path,
                 query_params.sort,
                 query_params.order,
-                uses_random_route,
+                uses_path_prefix,
                 &favicon_route,
                 &css_route,
                 default_color_scheme,
@@ -214,7 +214,7 @@ pub fn upload_file(
                     &return_path,
                     query_params.sort,
                     query_params.order,
-                    uses_random_route,
+                    uses_path_prefix,
                     &favicon_route,
                     &css_route,
                     &default_color_scheme,
@@ -233,7 +233,7 @@ fn create_error_response(
     return_path: &str,
     sorting_method: Option<SortingMethod>,
     sorting_order: Option<SortingOrder>,
-    uses_random_route: bool,
+    uses_path_prefix: bool,
     favicon_route: &str,
     css_route: &str,
     default_color_scheme: &str,
@@ -252,7 +252,7 @@ fn create_error_response(
                     sorting_method,
                     sorting_order,
                     true,
-                    !uses_random_route,
+                    !uses_path_prefix,
                     favicon_route,
                     css_route,
                     default_color_scheme,

src/listing.rs

@@ -156,7 +156,7 @@ pub fn directory_listing(
     skip_symlinks: bool,
     show_hidden: bool,
     file_upload: bool,
-    random_route: Option<String>,
+    path_prefix: Option<String>,
     favicon_route: String,
     css_route: String,
     default_color_scheme: &str,
@@ -189,10 +189,10 @@ pub fn directory_listing(
     }
 
     let base = Path::new(serve_path);
-    let random_route_abs = format!("/{}", random_route.clone().unwrap_or_default());
-    let is_root = base.parent().is_none() || Path::new(&req.path()) == Path::new(&random_route_abs);
+    let path_prefix_abs = format!("/{}", path_prefix.clone().unwrap_or_default());
+    let is_root = base.parent().is_none() || Path::new(&req.path()) == Path::new(&path_prefix_abs);
 
-    let encoded_dir = match base.strip_prefix(random_route_abs) {
+    let encoded_dir = match base.strip_prefix(path_prefix_abs) {
         Ok(c_d) => Path::new("/").join(c_d),
         Err(_) => base.to_path_buf(),
     }
@@ -205,8 +205,7 @@ pub fn directory_listing(
         let decoded = percent_decode_str(&encoded_dir).decode_utf8_lossy();
 
         let mut res: Vec<Breadcrumb> = Vec::new();
-        let mut link_accumulator =
-            format!("/{}", random_route.map(|r| r + "/").unwrap_or_default());
+        let mut link_accumulator = format!("/{}", path_prefix.map(|r| r + "/").unwrap_or_default());
 
         let mut components = Path::new(&*decoded).components().peekable();