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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
// Copyright (c) 2016-2017 Martijn Rijkeboer <[email protected]>
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

use super::association::Association;
use super::binary_key::BinaryKey;
use super::binary_value::BinaryValue;
use super::color::Color;
use super::custom_icon_uuid::CustomIconUuid;
use super::entry_uuid::EntryUuid;
use super::icon::Icon;
use super::obfuscation::Obfuscation;
use super::string_key::StringKey;
use super::string_value::StringValue;
use super::strings_map::StringsMap;
use super::times::Times;
use crate::{common, GroupUuid};
use chrono::{DateTime, Utc};
use std::collections::HashMap;
use std::str;

/// An entry in the database.
#[derive(Clone, Debug, PartialEq)]
pub struct Entry {
    /// Auto-type associations.
    pub associations: Vec<Association>,

    /// Default auto-type sequence.
    pub auto_type_def_sequence: String,

    /// Whether auto-type is enabled.
    pub auto_type_enabled: bool,

    /// The type of obfuscation to use for auto-typing.
    pub auto_type_obfuscation: Obfuscation,

    /// The background color.
    pub background_color: Option<Color>,

    /// Map with binaries.
    pub binaries: HashMap<BinaryKey, BinaryValue>,

    /// The date and time this entry was created.
    pub creation_time: DateTime<Utc>,

    /// The identifier of this entry's custom icon if any.
    pub custom_icon_uuid: Option<CustomIconUuid>,

    /// Whether this entry expires.
    pub expires: bool,

    /// The date and time this entry will expire if expires is true.
    pub expiry_time: DateTime<Utc>,

    /// The foreground color.
    pub foreground_color: Option<Color>,

    /// This entry's history.
    pub history: Vec<Entry>,

    /// This entry's icon.
    pub icon: Icon,

    /// The date and time this entry was last accessed.
    pub last_accessed: DateTime<Utc>,

    /// The date and time this entry was last modified.
    pub last_modified: DateTime<Utc>,

    /// The date and time the location of this entry was changed.
    pub location_changed: DateTime<Utc>,

    /// Override URL.
    pub override_url: String,

    /// Map with strings.
    pub strings: StringsMap,

    /// The tags associated with this entry.
    pub tags: String,

    /// The usage count of this entry.
    pub usage_count: i32,

    /// The identifier of this entry.
    pub uuid: EntryUuid,

    /// The parent groups GroupUUID.
    pub parent: GroupUuid,
}

impl Entry {
    /// Create a new entry.
    pub fn new() -> Entry {
        let mut entry = Entry::default();
        entry.uuid = EntryUuid::new_random();
        entry
    }

    /// Gets the notes string if any.
    pub fn notes(&self) -> Option<&str> {
        self.other(StringKey::Notes)
    }

    /// Gets an other string if any.
    pub fn other(&self, key: StringKey) -> Option<&str> {
        match self.strings.get(&key) {
            Some(&StringValue::Plain(ref string)) => Some(string),
            Some(&StringValue::Protected(ref secstr)) => str::from_utf8(secstr.unsecure()).ok(),
            None => None,
        }
    }

    /// Gets the password string if any.
    pub fn password(&self) -> Option<&str> {
        self.other(StringKey::Password)
    }

    /// Sets the notes string value.
    pub fn set_notes<S: Into<String>>(&mut self, val: S) {
        self.strings
            .insert(StringKey::Notes, StringValue::new(val, common::PROTECT_NOTES_DEFAULT));
    }

    /// Sets an other string value.
    pub fn set_other<S: Into<String>>(&mut self, key: StringKey, val: S) {
        self.strings.insert(key, StringValue::new(val, false));
    }

    /// Sets the password string value.
    pub fn set_password<S: Into<String>>(&mut self, val: S) {
        self.strings
            .insert(StringKey::Password, StringValue::new(val, common::PROTECT_PASSWORD_DEFAULT));
    }

    /// Sets the title string value.
    pub fn set_title<S: Into<String>>(&mut self, val: S) {
        self.strings
            .insert(StringKey::Title, StringValue::new(val, common::PROTECT_TITLE_DEFAULT));
    }

    /// Sets the url string value.
    pub fn set_url<S: Into<String>>(&mut self, val: S) {
        self.strings
            .insert(StringKey::Url, StringValue::new(val, common::PROTECT_URL_DEFAULT));
    }

    /// Sets the username string value.
    pub fn set_username<S: Into<String>>(&mut self, val: S) {
        self.strings
            .insert(StringKey::Username, StringValue::new(val, common::PROTECT_USERNAME_DEFAULT));
    }

    /// Gets the title string if any.
    pub fn title(&self) -> Option<&str> {
        self.other(StringKey::Title)
    }

    /// Gets the url string if any.
    pub fn url(&self) -> Option<&str> {
        self.other(StringKey::Url)
    }

    /// Gets the username string if any.
    pub fn username(&self) -> Option<&str> {
        self.other(StringKey::Username)
    }
}

impl Default for Entry {
    fn default() -> Entry {
        let now = Utc::now();
        Entry {
            associations: Vec::new(),
            auto_type_def_sequence: String::new(),
            auto_type_enabled: true,
            auto_type_obfuscation: Obfuscation::None,
            background_color: None,
            binaries: HashMap::new(),
            creation_time: now,
            custom_icon_uuid: None,
            expires: false,
            expiry_time: now,
            foreground_color: None,
            history: Vec::new(),
            icon: Icon::Key,
            last_accessed: now,
            last_modified: now,
            location_changed: now,
            override_url: String::new(),
            strings: StringsMap::new(),
            tags: String::new(),
            usage_count: 0,
            uuid: EntryUuid::nil(),
            parent: GroupUuid::nil(),
        }
    }
}

impl Times for Entry {
    fn creation_time(&self) -> DateTime<Utc> {
        self.creation_time
    }

    fn expires(&self) -> bool {
        self.expires
    }

    fn expiry_time(&self) -> DateTime<Utc> {
        self.expiry_time
    }

    fn last_accessed(&self) -> DateTime<Utc> {
        self.last_accessed
    }

    fn last_modified(&self) -> DateTime<Utc> {
        self.last_modified
    }

    fn location_changed(&self) -> DateTime<Utc> {
        self.location_changed
    }

    fn usage_count(&self) -> i32 {
        self.usage_count
    }

    fn set_creation_time(&mut self, val: DateTime<Utc>) {
        self.creation_time = val;
    }

    fn set_expires(&mut self, val: bool) {
        self.expires = val;
    }

    fn set_expiry_time(&mut self, val: DateTime<Utc>) {
        self.expiry_time = val;
    }

    fn set_last_accessed(&mut self, val: DateTime<Utc>) {
        self.last_accessed = val;
    }

    fn set_last_modified(&mut self, val: DateTime<Utc>) {
        self.last_modified = val;
    }

    fn set_location_changed(&mut self, val: DateTime<Utc>) {
        self.location_changed = val;
    }

    fn set_usage_count(&mut self, val: i32) {
        self.usage_count = val;
    }
}

#[cfg(test)]
mod tests {

    use super::*;
    use crate::types::EntryUuid;
    use crate::types::Icon;
    use crate::types::Obfuscation;
    use crate::types::StringKey;
    use crate::types::StringsMap;
    use crate::utils::test::approx_equal_datetime;
    use chrono::Utc;
    use std::collections::HashMap;

    #[test]
    fn test_new_returns_correct_instance() {
        let now = Utc::now();
        let entry = Entry::new();
        assert_eq!(entry.associations, Vec::new());
        assert_eq!(entry.auto_type_def_sequence, "");
        assert_eq!(entry.auto_type_enabled, true);
        assert_eq!(entry.auto_type_obfuscation, Obfuscation::None);
        assert_eq!(entry.background_color, None);
        assert_eq!(entry.binaries, HashMap::new());
        assert!(approx_equal_datetime(entry.creation_time, now));
        assert_eq!(entry.custom_icon_uuid, None);
        assert_eq!(entry.expires, false);
        assert!(approx_equal_datetime(entry.expiry_time, now));
        assert_eq!(entry.foreground_color, None);
        assert_eq!(entry.history, Vec::new());
        assert_eq!(entry.icon, Icon::Key);
        assert!(approx_equal_datetime(entry.last_accessed, now));
        assert!(approx_equal_datetime(entry.last_modified, now));
        assert!(approx_equal_datetime(entry.location_changed, now));
        assert_eq!(entry.override_url, "");
        assert_eq!(entry.strings, StringsMap::new());
        assert_eq!(entry.tags, "");
        assert_eq!(entry.usage_count, 0);
        assert!(entry.uuid != EntryUuid::nil());
    }

    #[test]
    fn test_notes_returns_none_on_default_entry() {
        let entry = Entry::default();
        assert_eq!(entry.notes(), None);
    }

    #[test]
    fn test_other_returns_none_on_default_entry() {
        let entry = Entry::default();
        let key = StringKey::from_string("other");
        assert_eq!(entry.other(key), None);
    }

    #[test]
    fn test_password_returns_none_on_default_entry() {
        let entry = Entry::default();
        assert_eq!(entry.password(), None);
    }

    #[test]
    fn test_set_notes_sets_notes() {
        let mut entry = Entry::default();
        entry.set_notes("test");
        assert_eq!(entry.notes(), Some("test"));
    }

    #[test]
    fn test_set_other_sets_other() {
        let mut entry = Entry::default();
        let key = StringKey::from_string("other");
        entry.set_other(key.clone(), "test");
        assert_eq!(entry.other(key), Some("test"));
    }

    #[test]
    fn test_set_password_sets_password() {
        let mut entry = Entry::default();
        entry.set_password("test");
        assert_eq!(entry.password(), Some("test"));
    }

    #[test]
    fn test_set_title_sets_title() {
        let mut entry = Entry::default();
        entry.set_title("test");
        assert_eq!(entry.title(), Some("test"));
    }

    #[test]
    fn test_set_url_sets_url() {
        let mut entry = Entry::default();
        entry.set_url("test");
        assert_eq!(entry.url(), Some("test"));
    }

    #[test]
    fn test_set_username_sets_username() {
        let mut entry = Entry::default();
        entry.set_username("test");
        assert_eq!(entry.username(), Some("test"));
    }

    #[test]
    fn test_title_returns_none_on_default_entry() {
        let entry = Entry::default();
        assert_eq!(entry.title(), None);
    }

    #[test]
    fn test_url_returns_none_on_default_entry() {
        let entry = Entry::default();
        assert_eq!(entry.url(), None);
    }

    #[test]
    fn test_username_returns_none_on_default_entry() {
        let entry = Entry::default();
        assert_eq!(entry.username(), None);
    }

    #[test]
    fn test_default_returns_correct_instance() {
        let now = Utc::now();
        let entry = Entry::default();
        assert_eq!(entry.associations, Vec::new());
        assert_eq!(entry.auto_type_def_sequence, "");
        assert_eq!(entry.auto_type_enabled, true);
        assert_eq!(entry.auto_type_obfuscation, Obfuscation::None);
        assert_eq!(entry.background_color, None);
        assert_eq!(entry.binaries, HashMap::new());
        assert!(approx_equal_datetime(entry.creation_time, now));
        assert_eq!(entry.custom_icon_uuid, None);
        assert_eq!(entry.expires, false);
        assert!(approx_equal_datetime(entry.expiry_time, now));
        assert_eq!(entry.foreground_color, None);
        assert_eq!(entry.history, Vec::new());
        assert_eq!(entry.icon, Icon::Key);
        assert!(approx_equal_datetime(entry.last_accessed, now));
        assert!(approx_equal_datetime(entry.last_modified, now));
        assert!(approx_equal_datetime(entry.location_changed, now));
        assert_eq!(entry.override_url, "");
        assert_eq!(entry.strings, StringsMap::new());
        assert_eq!(entry.tags, "");
        assert_eq!(entry.usage_count, 0);
        assert_eq!(entry.uuid, EntryUuid::nil());
    }
}