e62rs 1.5.0

An in-terminal E621/926 browser.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

//! media gallery stuff
use {
    crate::{
        getopt,
        serve::media::{
            filter::MediaFilter,
            item::MediaItem,
            scanner::{FsScanner, MediaScanner},
            stats::FilterStats,
            types::MediaType,
        },
    },
    std::path::{Path, PathBuf},
};

/// the media gallery
pub struct MediaGallery {
    /// the media scanner
    scanner: Box<dyn MediaScanner>,
    /// the directory to make a gallery from
    directory: PathBuf,
    /// the cached items
    cached_items: Option<Vec<MediaItem>>,
}

impl MediaGallery {
    /// initialize the media gallery
    pub fn new(directory: PathBuf, load_metadata: bool) -> Self {
        Self {
            scanner: Box::new(FsScanner::with_threads(
                load_metadata,
                getopt!(gallery.load_threads),
            )),
            directory,
            cached_items: None,
        }
    }

    /// initialize the media gallery with a custom scanner
    pub fn with_scanner(directory: PathBuf, scanner: Box<dyn MediaScanner>) -> Self {
        Self {
            scanner,
            directory,
            cached_items: None,
        }
    }

    /// get all media items
    pub async fn get_items(&mut self) -> Result<&[MediaItem], std::io::Error> {
        if self.cached_items.is_none() {
            let items = self.scanner.scan(&self.directory).await?;
            self.cached_items = Some(items);
        }

        Ok(self.cached_items.as_ref().expect("cached_items is None"))
    }

    /// get all media items with the given filters applied
    pub async fn get_filtered_items(
        &mut self,
        filter: &MediaFilter,
    ) -> Result<Vec<MediaItem>, std::io::Error> {
        Ok(self
            .get_items()
            .await?
            .iter()
            .filter(|item| filter.matches(item))
            .cloned()
            .collect())
    }

    /// refresh the gallery
    pub async fn refresh(&mut self) -> Result<&[MediaItem], std::io::Error> {
        self.cached_items = Some(self.scanner.scan(&self.directory).await?);
        Ok(self.cached_items.as_ref().expect("cached_items is None"))
    }

    /// filter media items by type
    pub fn filter_by_type(&self, media_type: &MediaType) -> Vec<MediaItem> {
        self.cached_items
            .as_ref()
            .map(|items| {
                items
                    .iter()
                    .filter(|item| item.media_type() == media_type)
                    .cloned()
                    .collect()
            })
            .unwrap_or_default()
    }

    /// search all media items based on a given query
    pub fn search(&self, query: &str) -> Vec<MediaItem> {
        self.cached_items
            .as_ref()
            .map(|items| {
                items
                    .iter()
                    .filter(|item| item.matches_search(query))
                    .cloned()
                    .collect()
            })
            .unwrap_or_default()
    }

    /// get the directory being used for the gallery
    pub fn directory(&self) -> &Path {
        &self.directory
    }

    /// get the filter stats of the current loaded items
    pub fn get_filter_stats(&self) -> FilterStats {
        FilterStats::from_items(self.cached_items.as_deref().unwrap_or(&[]))
    }
}