2018-04-10 19:57:11 +00:00
|
|
|
//
|
|
|
|
// imag - the personal information management suite for the commandline
|
2019-01-03 01:32:07 +00:00
|
|
|
// Copyright (C) 2015-2019 Matthias Beyer <mail@beyermatthias.de> and contributors
|
2018-04-10 19:57:11 +00:00
|
|
|
//
|
|
|
|
// 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;
|
|
|
|
|
2018-04-10 20:32:50 +00:00
|
|
|
use filters::filter::Filter;
|
|
|
|
|
2018-04-10 19:57:11 +00:00
|
|
|
use libimagstore::store::Store;
|
2018-04-10 20:32:50 +00:00
|
|
|
use libimagstore::store::Entry;
|
2018-04-10 19:57:11 +00:00
|
|
|
use libimagstore::store::FileLockEntry;
|
|
|
|
use libimagstore::storeid::IntoStoreId;
|
2018-04-10 20:32:50 +00:00
|
|
|
use libimagstore::storeid::StoreId;
|
|
|
|
use libimagstore::storeid::StoreIdIteratorWithStore;
|
2018-04-16 08:32:52 +00:00
|
|
|
use libimagentrylink::internal::InternalLinker;
|
2018-04-10 19:57:11 +00:00
|
|
|
|
2018-10-30 17:40:51 +00:00
|
|
|
use failure::Fallible as Result;
|
2018-10-17 12:43:21 +00:00
|
|
|
use failure::Error;
|
2018-10-30 17:40:51 +00:00
|
|
|
use failure::err_msg;
|
2018-04-10 19:57:11 +00:00
|
|
|
|
|
|
|
pub struct Wiki<'a, 'b>(&'a Store, &'b str);
|
|
|
|
|
2018-04-16 08:33:17 +00:00
|
|
|
/// An interface for accessing, creating and deleting "wiki pages"
|
|
|
|
///
|
|
|
|
/// Wiki pages are normal entries with some details added.
|
|
|
|
///
|
|
|
|
///
|
|
|
|
/// # Details
|
|
|
|
///
|
|
|
|
/// Entries are automatically linked to the "index" page when created and retrieved.
|
|
|
|
///
|
2018-04-10 19:57:11 +00:00
|
|
|
impl<'a, 'b> Wiki<'a, 'b> {
|
|
|
|
|
|
|
|
pub(crate) fn new(store: &'a Store, name: &'b str) -> Wiki<'a, 'b> {
|
|
|
|
Wiki(store, name)
|
|
|
|
}
|
|
|
|
|
2018-04-16 08:32:52 +00:00
|
|
|
pub(crate) fn create_index_page(&self) -> Result<FileLockEntry<'a>> {
|
|
|
|
let path = PathBuf::from(format!("{}/index", self.1));
|
|
|
|
let sid = ::module_path::ModuleEntryPath::new(path).into_storeid()?;
|
|
|
|
|
2018-10-30 17:40:51 +00:00
|
|
|
self.0.create(sid)
|
2018-04-16 08:32:52 +00:00
|
|
|
}
|
|
|
|
|
2018-10-17 12:43:21 +00:00
|
|
|
pub(crate) fn get_index_page(&self) -> Result<FileLockEntry<'a>> {
|
|
|
|
let path = PathBuf::from(format!("{}/index", self.1));
|
|
|
|
let sid = ::module_path::ModuleEntryPath::new(path).into_storeid()?;
|
|
|
|
|
|
|
|
self.0
|
|
|
|
.get(sid)
|
|
|
|
.map_err(Error::from)?
|
|
|
|
.ok_or_else(|| Error::from(err_msg("Missing index")))
|
|
|
|
}
|
|
|
|
|
2018-04-10 20:41:46 +00:00
|
|
|
pub fn get_entry<EN: AsRef<str>>(&self, entry_name: EN) -> Result<Option<FileLockEntry<'a>>> {
|
|
|
|
let path = PathBuf::from(format!("{}/{}", self.1, entry_name.as_ref()));
|
|
|
|
let sid = ::module_path::ModuleEntryPath::new(path).into_storeid()?;
|
2018-10-30 17:40:51 +00:00
|
|
|
self.0.get(sid)
|
2018-04-10 20:41:46 +00:00
|
|
|
}
|
|
|
|
|
2018-04-10 19:57:11 +00:00
|
|
|
pub fn create_entry<EN: AsRef<str>>(&self, entry_name: EN) -> Result<FileLockEntry<'a>> {
|
2018-04-16 08:32:52 +00:00
|
|
|
let path = PathBuf::from(format!("{}/{}", self.1, entry_name.as_ref()));
|
|
|
|
let sid = ::module_path::ModuleEntryPath::new(path).into_storeid()?;
|
|
|
|
let mut index = self
|
|
|
|
.get_entry("index")?
|
2018-10-30 17:40:51 +00:00
|
|
|
.ok_or_else(|| err_msg("Missing index page"))?;
|
2018-04-16 08:32:52 +00:00
|
|
|
let mut entry = self.0.create(sid)?;
|
|
|
|
|
2018-10-30 17:40:51 +00:00
|
|
|
entry.add_internal_link(&mut index).map(|_| entry)
|
2018-04-10 19:57:11 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
pub fn retrieve_entry<EN: AsRef<str>>(&self, entry_name: EN) -> Result<FileLockEntry<'a>> {
|
2018-04-16 08:32:52 +00:00
|
|
|
let path = PathBuf::from(format!("{}/{}", self.1, entry_name.as_ref()));
|
|
|
|
let sid = ::module_path::ModuleEntryPath::new(path).into_storeid()?;
|
|
|
|
let mut index = self
|
|
|
|
.get_entry("index")?
|
2018-10-30 17:40:51 +00:00
|
|
|
.ok_or_else(|| err_msg("Missing index page"))?;
|
2018-04-16 08:32:52 +00:00
|
|
|
let mut entry = self.0.retrieve(sid)?;
|
|
|
|
|
2018-10-30 17:40:51 +00:00
|
|
|
entry.add_internal_link(&mut index).map(|_| entry)
|
2018-04-10 19:57:11 +00:00
|
|
|
}
|
|
|
|
|
2018-04-10 20:32:50 +00:00
|
|
|
pub fn all_ids(&self) -> Result<WikiIdIterator> {
|
|
|
|
let filter = IdIsInWikiFilter(self.1);
|
Optimize the Store::entries() interface
The previous iterator was implemented to simply fetch _all_ pathes from
the filesystem, no matter what.
With this implementation, this changes. The iterator now has
functionality to optimize the iteration, if only a subdirectory of the
store is required, for example `$STORE/foo`.
This is done via functionality where the underlying iterator gets
altered.
First of all, the interface was changed to return a `Entries` object,
which itself only covers the libimagstore-internal `PathIterator` type.
This type was changed so that the backend implementation provides an
"PathIterBuilder`, which builds the actual iterator object for the
`PathIterator` type.
The intermediate `StoreIdConstructingIterator` was merged into
`PathIterator` for simplicity.
The `Entries` type got functionality similar to the
`StoreIdIteratorWithStore` type for easier transition to the new API.
This should probably be removed at a later point, though.
As the `walkdir::WalkDir` type is not as nice as it could be, iterators
for two collections in the store could be built like this (untested):
store
.entries()?
.in_collection("foo")
.chain(store.entries()?.in_collection("bar"))
Functionality to exclude subdirectories is not possible with the current
`walkdir::WalkDir` implementation and has to be done during iteration,
with filtering (as usual).
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2018-06-06 22:29:52 +00:00
|
|
|
Ok(WikiIdIterator(self.0.entries()?.without_store().with_store(self.0), filter))
|
2018-04-10 20:32:50 +00:00
|
|
|
}
|
|
|
|
|
2018-04-14 13:49:03 +00:00
|
|
|
pub fn delete_entry<EN: AsRef<str>>(&self, entry_name: EN) -> Result<()> {
|
|
|
|
let path = PathBuf::from(format!("{}/{}", self.1, entry_name.as_ref()));
|
|
|
|
let sid = ::module_path::ModuleEntryPath::new(path).into_storeid()?;
|
2018-10-30 17:40:51 +00:00
|
|
|
self.0.delete(sid)
|
2018-04-14 13:49:03 +00:00
|
|
|
}
|
2018-04-10 20:32:50 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
pub struct WikiIdIterator<'a>(StoreIdIteratorWithStore<'a>, IdIsInWikiFilter<'a>);
|
|
|
|
|
|
|
|
impl<'a> Iterator for WikiIdIterator<'a> {
|
2018-04-30 15:28:54 +00:00
|
|
|
type Item = Result<StoreId>;
|
2018-04-10 20:32:50 +00:00
|
|
|
|
|
|
|
fn next(&mut self) -> Option<Self::Item> {
|
|
|
|
while let Some(next) = self.0.next() {
|
2018-04-30 15:28:54 +00:00
|
|
|
match next {
|
|
|
|
Ok(next) => if self.1.filter(&next) {
|
|
|
|
return Some(Ok(next));
|
|
|
|
},
|
2018-10-30 17:40:51 +00:00
|
|
|
Err(e) => return Some(Err(e)),
|
2018-04-10 20:32:50 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
None
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
pub struct IdIsInWikiFilter<'a>(&'a str);
|
|
|
|
|
|
|
|
impl<'a> IdIsInWikiFilter<'a> {
|
|
|
|
pub fn new(wiki_name: &'a str) -> Self {
|
|
|
|
IdIsInWikiFilter(wiki_name)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<'a> Filter<StoreId> for IdIsInWikiFilter<'a> {
|
|
|
|
fn filter(&self, id: &StoreId) -> bool {
|
|
|
|
id.is_in_collection(&["wiki", &self.0])
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<'a> Filter<Entry> for IdIsInWikiFilter<'a> {
|
|
|
|
fn filter(&self, e: &Entry) -> bool {
|
|
|
|
e.get_location().is_in_collection(&["wiki", &self.0])
|
|
|
|
}
|
2018-04-10 19:57:11 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|