summaryrefslogtreecommitdiff
path: root/lib/entry/libimagentrycategory/src/register.rs
blob: af23d5bf9ef016b361c0f2c01e9abe0f3d58543e (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
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
//
// imag - the personal information management suite for the commandline
// Copyright (C) 2015, 2016 Matthias Beyer <mail@beyermatthias.de> and contributors
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; version
// 2.1 of the License.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//

use std::path::PathBuf;

use toml_query::insert::TomlValueInsertExt;
use toml_query::read::TomlValueReadExt;
use toml::Value;

use libimagstore::store::Store;
use libimagstore::store::FileLockEntry;
use libimagstore::storeid::StoreId;
use libimagstore::storeid::StoreIdIterator;

use category::Category;
use error::CategoryErrorKind as CEK;
use error::CategoryError as CE;
use error::ResultExt;
use error::Result;

pub const CATEGORY_REGISTER_NAME_FIELD_PATH : &'static str = "category.register.name";

/// Extension on the Store to make it a register for categories
///
/// The register writes files to the
pub trait CategoryRegister {

    fn category_exists(&self, name: &str) -> Result<bool>;

    fn create_category(&self, name: &str) -> Result<bool>;

    fn delete_category(&self, name: &str) -> Result<()>;

    fn all_category_names(&self) -> Result<CategoryNameIter>;

    fn get_category_by_name(&self, name: &str) -> Result<Option<FileLockEntry>>;

}

impl CategoryRegister for Store {

    /// Check whether a category exists
    fn category_exists(&self, name: &str) -> Result<bool> {
        let sid = mk_category_storeid(self.path().clone(), name)?;
        represents_category(self, sid, name)
    }

    /// Create a category
    ///
    /// Fails if the category already exists (returns false then)
    fn create_category(&self, name: &str) -> Result<bool> {
        use libimagstore::error::StoreErrorKind as SEK;

        let sid = mk_category_storeid(self.path().clone(), name)?;


        match self.create(sid) {
            Ok(mut entry) => {
                let val = Value::String(String::from(name));
                entry.get_header_mut()
                    .insert(CATEGORY_REGISTER_NAME_FIELD_PATH, val)
                    .map(|opt| if opt.is_none() {
                        debug!("Setting category header worked")
                    } else {
                        warn!("Setting category header replaced existing value: {:?}", opt);
                    })
                    .map(|_| true)
                    .chain_err(|| CEK::HeaderWriteError)
                    .chain_err(|| CEK::StoreWriteError)
            }
            Err(store_error) => if is_match!(store_error.kind(), &SEK::EntryAlreadyExists(_)) {
                Ok(false)
            } else {
                Err(store_error).chain_err(|| CEK::StoreWriteError)
            }
        }
    }

    /// Delete a category
    fn delete_category(&self, name: &str) -> Result<()> {
        let sid = mk_category_storeid(self.path().clone(), name)?;

        self.delete(sid).chain_err(|| CEK::StoreWriteError)
    }

    /// Get all category names
    fn all_category_names(&self) -> Result<CategoryNameIter> {
        self.retrieve_for_module("category")
            .chain_err(|| CEK::StoreReadError)
            .map(|iter| CategoryNameIter::new(self, iter))
    }

    /// Get a category by its name
    ///
    /// Returns the FileLockEntry which represents the category, so one can link to it and use it
    /// like a normal file in the store (which is exactly what it is).
    fn get_category_by_name(&self, name: &str) -> Result<Option<FileLockEntry>> {
        let sid = mk_category_storeid(self.path().clone(), name)?;

        self.get(sid)
            .chain_err(|| CEK::StoreWriteError)
    }
}

#[cfg(test)]
mod tests {
    extern crate env_logger;
    use std::path::PathBuf;

    use super::*;

    use libimagstore::store::Store;

    pub fn get_store() -> Store {
        use libimagstore::store::InMemoryFileAbstraction;
        let backend = Box::new(InMemoryFileAbstraction::new());
        Store::new_with_backend(PathBuf::from("/"), None, backend).unwrap()
    }

    #[test]
    fn test_non_existing_category_exists() {
        let exists = get_store().category_exists("nonexistent");

        assert!(exists.is_ok(), format!("Expected Ok(_), got: {:?}", exists));
        let exists = exists.unwrap();

        assert!(!exists);
    }

    #[test]
    fn test_creating_category() {
        let category_name = "examplecategory";
        let store         = get_store();
        let res           = store.create_category(category_name);

        assert!(res.is_ok(), format!("Expected Ok(_), got: {:?}", res));
        let res = res.unwrap();
        assert!(res);
    }

    #[test]
    fn test_creating_category_creates_store_entry() {
        let category_name = "examplecategory";
        let store         = get_store();

        let res           = store.create_category(category_name);

        assert!(res.is_ok(), format!("Expected Ok(_), got: {:?}", res));
        let res = res.unwrap();
        assert!(res);

        let category = store.get(PathBuf::from(format!("category/{}", category_name)));

        assert!(category.is_ok(), format!("Expected Ok(_), got: {:?}", category));
        let category = category.unwrap();

        assert!(category.is_some());
    }

    #[test]
    fn test_creating_category_creates_store_entry_with_header_field_set() {
        let _ = env_logger::init();
        let category_name = "examplecategory";
        let store         = get_store();
        let res           = store.create_category(category_name);

        assert!(res.is_ok(), format!("Expected Ok(_), got: {:?}", res));
        let res = res.unwrap();
        assert!(res);

        let id = PathBuf::from(format!("category/{}", category_name));
        println!("Trying: {:?}", id);
        let category = store.get(id);

        assert!(category.is_ok(), format!("Expected Ok(_), got: {:?}", category));
        let category = category.unwrap();

        assert!(category.is_some());
        let category = category.unwrap();

        let header_field = category.get_header().read(CATEGORY_REGISTER_NAME_FIELD_PATH);
        assert!(header_field.is_ok(), format!("Expected Ok(_), got: {:?}", header_field));
        let header_field = header_field.unwrap();

        match header_field {
            Some(&Value::String(ref s)) => assert_eq!(category_name, s),
            Some(_) => assert!(false, "Header field has wrong type"),
            None    => assert!(false, "Header field not present"),
        }
    }
}

#[inline]
fn mk_category_storeid(base: PathBuf, s: &str) -> Result<StoreId> {
    use libimagstore::storeid::IntoStoreId;
    ::module_path::ModuleEntryPath::new(s)
        .into_storeid()
        .map(|id| id.with_base(base))
        .chain_err(|| CEK::StoreIdHandlingError)
}

#[inline]
fn represents_category(store: &Store, sid: StoreId, name: &str) -> Result<bool> {
    sid.exists()
        .chain_err(|| CEK::StoreIdHandlingError)
        .and_then(|bl| {
            if bl {
                store.get(sid)
                    .chain_err(|| CEK::StoreReadError)
                    .and_then(|fle| {
                        if let Some(fle) = fle {
                            match fle.get_header()
                                .read(&String::from(CATEGORY_REGISTER_NAME_FIELD_PATH))
                                .chain_err(|| CEK::HeaderReadError)
                            {
                                Ok(Some(&Value::String(ref s))) => Ok(s == name),
                                Ok(_)                     => Err(CE::from_kind(CEK::TypeError)),
                                Err(e)                    => Err(e).chain_err(|| CEK::HeaderReadError),
                            }
                        } else {
                            Ok(false)
                        }
                    })
            } else {
                Ok(bl) // false
            }
        })
}

/// Iterator for Category names
///
/// Iterates over Result<Category>
///
/// # Return values
///
/// In each iteration, a Option<Result<Category>> is returned. Error kinds are as follows:
///
/// * CategoryErrorKind::StoreReadError if a name could not be fetched from the store
/// * CategoryErrorKind::HeaderReadError if the header of the fetched item couldn't be read
/// * CategoryErrorKind::TypeError if the name could not be fetched because it is not a String
///
pub struct CategoryNameIter<'a>(&'a Store, StoreIdIterator);

impl<'a> CategoryNameIter<'a> {

    fn new(store: &'a Store, sidit: StoreIdIterator) -> CategoryNameIter<'a> {
        CategoryNameIter(store, sidit)
    }

}

impl<'a> Iterator for CategoryNameIter<'a> {
    type Item = Result<Category>;

    fn next(&mut self) -> Option<Self::Item> {
        // TODO: Optimize me with lazy_static
        let query = String::from(CATEGORY_REGISTER_NAME_FIELD_PATH);

        self.1
            .next()
            .map(|sid| {
                self.0
                    .get(sid)
                    .chain_err(|| CEK::StoreReadError)
                    .and_then(|fle| fle.ok_or(CE::from_kind(CEK::StoreReadError)))
                    .and_then(|fle| match fle.get_header().read(&query) {
                        Ok(Some(&Value::String(ref s))) => Ok(Category::from(s.clone())),
                        Ok(_)  => Err(CE::from_kind(CEK::TypeError)),
                        Err(e) => Err(e).chain_err(|| CEK::HeaderReadError),
                    })
            })
    }
}