summaryrefslogtreecommitdiff
path: root/src/types.rs
blob: df2c3877b7972ead6e6d773df919ad016e1933ca (plain)
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
use std::path::PathBuf;

use serde::{Deserialize, Serialize};
use serde_repr::{Deserialize_repr, Serialize_repr};
use thiserror::Error;

/// Error wrapper
#[derive(Error, Debug)]
pub enum HydrusError {
    #[error("failed to connect to Hydrus")]
    NetworkError(reqwest::Error),
    #[error("failed to encode/Deserialize data")]
    DeserializeError(serde_json::Error),
    #[error("io error")]
    IOError(std::io::Error),
    #[error("api or session key needed")]
    KeyNotSupplied,
}

impl From<serde_json::Error> for HydrusError {
    fn from(value: serde_json::Error) -> Self {
        HydrusError::DeserializeError(value)
    }
}

impl From<std::io::Error> for HydrusError {
    fn from(value: std::io::Error) -> Self {
        HydrusError::IOError(value)
    }
}

impl From<reqwest::Error> for HydrusError {
    fn from(value: reqwest::Error) -> Self {
        HydrusError::NetworkError(value)
    }
}

/// Hydrus serivce permissions object
#[derive(PartialEq, Debug, Clone, Serialize_repr, Deserialize_repr)]
#[repr(u8)]
pub enum HydrusPermissions {
    ImportAndEditURLs = 0,
    ImportAndEditFiles,
    EditFileTags,
    SearchAndFetchFiles,
    ManagePages,
    ManageCookiesAndHeaders,
    ManageDatabase,
    EditFileNotes,
    EditFileRelationships,
    EditFileRatings,
    ManagePopups,
    EditFileTimes,
    CommitPending,
    SeeLocalPaths,
    Null = 255,
}

/// Hydrus key information struct
#[derive(Deserialize, Debug)]
pub struct KeyInfo {
    pub name: String,
    pub permits_everything: bool,
    pub basic_permissions: Vec<HydrusPermissions>,
    pub human_permissions: String,
}

/// Hydrus service type object
#[derive(PartialEq, Debug, Clone, Serialize_repr, Deserialize_repr)]
#[repr(u8)]
pub enum ServiceType {
    TagRepository = 0,
    FileRepository,
    LocalFileDomain,
    LocalTagDomain = 5,
    NumericalRating,
    BoolRating,
    AllKnownTags = 10,
    AllKnownFiles,
    LocalBooru,
    IPFS,
    Trash,
    AllLocalFiles,
    FileNotes = 17,
    ClientAPI,
    DeletedFromAnywhere,
    LocalUpdates,
    AllMyFiles,
    IncDecRating,
    ServerAdmin = 99,
    Null = 255,
}

/// Hydrus service struct
#[derive(Deserialize, Debug, Clone)]
pub struct Service {
    pub name: String,
    #[serde(default)]
    pub service_key: String,
    pub r#type: ServiceType,
    pub type_pretty: String,
    #[serde(default)]
    pub star_shape: Option<String>,
    #[serde(default)]
    pub min_stars: Option<u8>,
    #[serde(default)]
    pub max_stars: Option<u8>,
}

/// Hydrus file domains
pub enum FileDomain {
    FileServiceKey(String),
    FileServiceKeys(Vec<String>),
    DeletedFileServiceKey(String),
    DeletedFileServiceKeys(Vec<String>),
}

/// Payload for importing a file via providing a local path
#[derive(Serialize, Debug, Default)]
pub struct AddFileRequest {
    pub path: PathBuf,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub delete_after_successful_import: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file_service_key: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file_service_keys: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deleted_file_service_key: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deleted_file_service_keys: Option<Vec<String>>,
}
/// File importing status
#[derive(PartialEq, Debug, Clone, Serialize_repr, Deserialize_repr)]
#[repr(u8)]
pub enum AddFileStatus {
    SuccessfulImport = 1,
    AlreadyInDatabase,
    PreviouslyDeleted,
    FailedToImport,
    FileVetoed = 7,
}
/// File importing api response
#[derive(Deserialize)]
pub struct AddFileResponse {
    pub status: AddFileStatus,
    pub hash: String,
    pub note: String,
}

/// Hydrus file object
#[derive(Debug, Clone, Serialize)]
pub enum HydrusFile {
    #[serde(rename(serialize = "file_id"))]
    FileId(String),
    #[serde(rename(serialize = "file_ids"))]
    FileIds(Vec<String>),
    #[serde(rename(serialize = "hash"))]
    Hash(String),
    #[serde(rename(serialize = "hashes"))]
    Hashes(Vec<String>),
}

impl Default for HydrusFile {
    fn default() -> Self {
        Self::FileId(String::from(""))
    }
}

/// Payload for various file-related requests
#[derive(Debug, Default)]
pub struct FileRequest {
    pub file: HydrusFile,
    pub delete_after_successful_import: Option<bool>,
    pub file_service_key: Option<String>,
    pub file_service_keys: Option<Vec<String>>,
    pub deleted_file_service_key: Option<String>,
    pub deleted_file_service_keys: Option<Vec<String>>,
    pub reason: Option<String>,
}

impl Serialize for FileRequest {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        use serde::ser::SerializeMap;
        let mut map = serializer.serialize_map(Some(1))?;

        match &self.file {
            HydrusFile::FileId(id) => map.serialize_entry("file_id", &id)?,
            HydrusFile::FileIds(ids) => map.serialize_entry("file_ids", &ids)?,
            HydrusFile::Hash(hash) => map.serialize_entry("hash", &hash)?,
            HydrusFile::Hashes(hashes) => map.serialize_entry("hashes", &hashes)?,
        }

        if let Some(val) = &self.reason {
            map.serialize_entry("reason", &val)?;
        }

        if let Some(val) = &self.file_service_key {
            map.serialize_entry("file_service_key", &val)?;
        }

        if let Some(val) = &self.file_service_keys {
            map.serialize_entry("file_service_keys", &val)?;
        }

        if let Some(val) = &self.deleted_file_service_key {
            map.serialize_entry("deleted_file_service_key", &val)?;
        }

        if let Some(val) = &self.deleted_file_service_keys {
            map.serialize_entry("deleted_file_service_keys", &val)?;
        }

        map.end()
    }
}

#[derive(Debug, Deserialize)]
pub struct HashResponse {
    pub hash: String,
    #[serde(default)]
    pub perceptual_hashes: Option<Vec<String>>,
    #[serde(default)]
    pub pixel_hash: Option<String>,
}