imag/libimagannotation/src/annotation.rs

//
// 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 libimagstore::store::Store;
use libimagstore::store::FileLockEntry;
use libimagstore::storeid::StoreId;
use libimagnotes::note::Note;

use result::Result;
use error::AnnotationErrorKind as AEK;

use module_path::ModuleEntryPath;

pub trait Annotateable {

    /// Add an annotation to `Self`, that is a `FileLockEntry` which is linked to `Self` (link as in
    /// libimagentrylink).
    ///
    /// This `Annotation` is stored in the Store itself.
    fn annotate(&self, store: &Store) -> Result<Annotation> {
        self.annotate_with_path_generator(store, DefaultAnnotationNameGenerator::new())
    }

    /// Add an annotation to `Self`, that is a `FileLockEntry` which is linked to `Self` (link as in
    /// libimagentrylink).
    ///
    /// This `Annotation` is stored in the Store itself.
    ///
    /// The `pg` is a AnnotationNameGenerator object which is used to generate a StoreId
    fn annotate_with_path_generator(&self, store: &Store, pg: &AnnotationNameGenerator) -> Result<Annotation>;

    /// List annotations of a Annotateable
    ///
    /// This lists only annotations that are generated via the `DefaultAnnotationNameGenerator`
    fn annotations(&self) -> Result<Vec<StoreId>>;

    /// Remove an annotation by its ID
    fn remove_annotation(&mut self, ann_id: &str) -> Result<()>;

    /// Remove an annotation and remove the annotation object from the store, if there's no more
    /// link to it.
    fn remove_annotation_with_gc(&mut self, ann_id: &str, store: &Store) -> Result<()>;

}

/// A AnnotationNameGenerator generates a unique path for the annotation to be generated.
pub trait AnnotationNameGenerator {
    fn generate_annotation_path(&self) -> Result<String>;
}

/// The DefaultAnnotationNameGenerator generates unique StoreIds for Annotations, where the
/// collection the annotations are stored in is `/annotation/`.
pub struct DefaultAnnotationNameGenerator;

impl AnnotationNameGenerator for DefaultAnnotationNameGenerator {

    fn generate_annotation_path(&self) -> Result<String> {
        Ok(format!("{}/{}", MODULE_ENTRY_PATH_NAME, Uuid::new_v4()))
    }

}

pub struct Annotation<'a>(Note<'a>);

impl Annotateable for FileLockEntry {

    fn annotate_with_path_generator(&self, store: &Store, pg: &AnnotationNameGenerator)
        -> Result<Annotation>
    {
        pb.generate_annotation_path()
            .and_then(|name| Note::new(store, name, String::new()).map_err_into(AEK::StoreWriteError))
            .and_then(|mut fle| {
                self.add_internal_link(&mut fle)
                    .map_err_into(AEK::LinkingError)
                    .map(|_| fle)
            })
            .map(Annotation)
    }

    /// Get the annotations of a FileLockEntry
    ///
    /// Returns the pathes to the annotations, not the annotations itself.
    fn annotations(&self) -> Result<Vec<StoreId>> {
        lazy_static! {
            static ref pb : PathBuf = PathBuf::from(format!("{}/{}",
                                                            libimagnotes::MODULE_ENTRY_PATH_NAME,
                                                            MODULE_ENTRY_PATH_NAME));
        };

        self.get_internal_links()
            .map_err_into(AEK::LinkError)
            .map(|v| v.iter_into().filter(|id| id.local().starts_with(pb)).collect())
    }

    /// Remove an annotation by its ID
    fn remove_annotation(&mut self, ann_id: &str) -> Result<()> {
        unimplemented!()
    }

    /// Remove an annotation and remove the annotation object from the store, if there's no more
    /// link to it.
    fn remove_annotation_with_gc(&mut self, ann_id: &str, store: &Store) -> Result<()> {
        unimplemented!()
    }

}