Merge pull request #1505 from 7sDream/feature/search

Minimalist search/filter feature

Author: svenstaro

README.md

@@ -118,6 +118,15 @@ You can enable a convenient copy-pastable footer for `wget` using `--show-wget-f
 Afterwards, check the bottom of any rendered page.
 It'll have a neat `wget` command you can easily copy-paste to recursively grab the current directory.
 
+### Use query parameter to do a simple filter
+
+You can pass a `?search=<keyword>` query parameter to only show files and directories whose name contains the `<keyword>`, for example:
+
+    miniserve .
+    # Then visit http://127.0.0.1:8080/src/?search=file
+
+This filter feature is case insensitive.
+
 ### Take pictures and upload them from smartphones:
 
     miniserve -u -m image -q
@@ -132,6 +141,7 @@ Some mobile browsers like Firefox on Android will offer to open the camera app w
 - Single binary drop-in with no extra dependencies required
 - Authentication support with username and password (and hashed password)
 - Mega fast and highly parallel (thanks to [Rust](https://www.rust-lang.org/) and [Actix](https://actix.rs/))
+- Search/filter by file or directory name
 - Folder download (compressed on the fly as `.tar.gz` or `.zip`)
 - File uploading
 - Directory creation

data/style.scss

@@ -744,6 +744,39 @@ th span.active span {
   margin-top: 4rem;
 }
 
+.title-search-box {
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+  flex-wrap: wrap;
+}
+
+.search-box {
+  display: flex;
+  align-items: center;
+}
+
+.search-box form {
+  display: flex;
+  align-items: center;
+}
+
+.search-box input {
+  padding: 0.5rem;
+  border-radius: 0.2rem;
+  border: 1px solid var(--upload_form_border_color);
+  margin-right: 0.2rem;
+}
+
+.search-box button {
+  background: var(--upload_button_background);
+  padding: 0.5rem;
+  border-radius: 0.2rem;
+  color: var(--upload_button_text_color);
+  border: none;
+  min-width: max-content;
+}
+
 @media (max-width: 760px) {
   nav {
     padding: 0 2.5rem;

src/listing.rs

@@ -46,6 +46,7 @@ pub struct ListingQueryParameters {
     pub sort: Option<SortingMethod>,
     pub order: Option<SortingOrder>,
     pub raw: Option<bool>,
+    pub search: Option<String>,
     download: Option<ArchiveMethod>,
 }
 
@@ -247,6 +248,13 @@ pub fn directory_listing(
     };
 
     let query_params = extract_query_parameters(req);
+    let search = query_params.search.as_ref().map(|s| s.to_lowercase());
+    let matches_search = move |filename: &str| -> bool {
+        match search {
+            Some(ref search) => filename.to_lowercase().contains(search),
+            None => true,
+        }
+    };
     let mut entries: Vec<Entry> = Vec::new();
     let mut readme: Option<(String, String)> = None;
     let readme_rx: Regex = Regex::new("^readme([.](md|txt))?$").unwrap();
@@ -280,6 +288,9 @@ pub fn directory_listing(
                 let last_modification_date = metadata.modified().ok();
 
                 if metadata.is_dir() {
+                    if !matches_search(&file_name) {
+                        continue;
+                    }
                     entries.push(Entry::new(
                         file_name,
                         EntryType::Directory,
@@ -317,14 +328,6 @@ pub fn directory_listing(
                         }
                         None => file_url,
                     };
-                    entries.push(Entry::new(
-                        file_name.clone(),
-                        EntryType::File,
-                        file_link,
-                        Some(ByteSize::b(metadata.len())),
-                        last_modification_date,
-                        symlink_dest,
-                    ));
                     if conf.readme && readme_rx.is_match(&file_name.to_lowercase()) {
                         let ext = file_name.split('.').next_back().unwrap().to_lowercase();
                         readme = Some((
@@ -344,6 +347,17 @@ pub fn directory_listing(
                             },
                         ));
                     }
+                    if !matches_search(&file_name) {
+                        continue;
+                    }
+                    entries.push(Entry::new(
+                        file_name.clone(),
+                        EntryType::File,
+                        file_link,
+                        Some(ByteSize::b(metadata.len())),
+                        last_modification_date,
+                        symlink_dest,
+                    ));
                 }
             } else {
                 continue;