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
//
// Wildland Project
//
// Copyright © 2022 Golem Foundation
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License version 3 as published by
// the Free Software Foundation.
//
// This program 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
use std::sync::Arc;
use uuid::Uuid;
use wildland_crypto::identity::SigningKeypair;
use crate::catlib_service::entities::{
CatlibContainerFilter,
ContainerPath,
Devices,
ForestManifest,
WildlandPubKey,
};
use crate::catlib_service::error::{CatlibError, CatlibResult};
use crate::rendered_storage::RenderedStorage;
use crate::{
Container,
ContainerData,
CoreXError,
ErrContext,
Storage,
StorageTemplate,
TemplateContext,
WildlandIdentity,
};
#[derive(Debug, Clone, PartialEq)]
pub struct ForestIdentity {
pub index: u64,
pub keypair: Arc<SigningKeypair>,
}
impl ForestIdentity {
pub fn new(index: u64, keypair: SigningKeypair) -> Self {
Self {
index,
keypair: Arc::new(keypair),
}
}
}
impl From<ForestIdentity> for WildlandIdentity {
fn from(value: ForestIdentity) -> Self {
WildlandIdentity::Forest(
value.index,
SigningKeypair::try_from_bytes_slices(value.keypair.public(), value.keypair.secret())
.unwrap(),
)
}
}
#[derive(Debug, Clone)]
pub struct Forest {
forest_manifest: Arc<dyn ForestManifest>,
identity: ForestIdentity,
}
impl Forest {
pub fn new(forest_manifest: Arc<dyn ForestManifest>, identity: ForestIdentity) -> Self {
Self {
forest_manifest,
identity,
}
}
/// Returns vector of forest's storage templates
///
#[tracing::instrument(level = "debug", skip_all)]
pub fn get_storage_templates(&self) -> CatlibResult<Vec<StorageTemplate>> {
self.forest_manifest
.get_storage_templates()?
.into_iter()
.map(|(uuid, data)| {
serde_json::from_slice::<StorageTemplate>(&data)
.map_err(|e| CatlibError::InvalidDataError(e.to_string()))
.map(|t| t.with_catlib_uuid(uuid))
})
.collect::<Result<_, CatlibError>>()
}
pub fn save_storage_template(
&self,
storage_template: StorageTemplate,
) -> CatlibResult<(Uuid, StorageTemplate)> {
let uuid = self.forest_manifest.save_storage_template(
storage_template.catlib_uuid(),
serde_json::to_string(&storage_template)
.map_err(|e| {
CatlibError::InvalidDataError(format!("Could not serialize object: {e}"))
})?
.into(),
)?;
Ok((uuid, storage_template.with_catlib_uuid(uuid)))
}
pub fn forest_manifest(&self) -> Arc<dyn ForestManifest> {
self.forest_manifest.clone()
}
pub fn identity(&self) -> &ForestIdentity {
&self.identity
}
/// ## Errors
///
/// Returns `RedisError` cast on [`crate::catlib_service::error::CatlibResult`] upon failure to save to the database.
///
/// ## Example
///
/// ```no_run
/// # use wildland_catlib::gql_catlib::GqlCatlib;
/// # use std::collections::HashMap;
/// # use wildland_corex::catlib_service::entities::WildlandPubKey;
/// # use wildland_corex::StorageTemplate;
/// # use wildland_corex::catlib_service::interface::CatLib;
/// # use wildland_corex::Forest;
/// # use wildland_corex::ForestIdentity;
/// # use wildland_corex::SigningKeypair;
/// # use wildland_corex::ValidatedTemplateData;
/// # use uuid::Uuid;
///
/// let catlib = GqlCatlib::new("http://localhost:8000/graphql/");
/// let forest = catlib.create_forest(
/// WildlandPubKey([1; 32]),
/// HashMap::from([(WildlandPubKey([2; 32]), "".into())]),
/// vec![],
/// ).unwrap();
/// let forest = Forest::new(forest, ForestIdentity::new(0, SigningKeypair::try_from_bytes_slices([0;32], [0;32]).unwrap()));
/// let storage_template = StorageTemplate::new(
/// "template type",
/// ValidatedTemplateData(
/// serde_json::to_value(&HashMap::from([
/// (
/// "field1".to_owned(),
/// "Some value with container name: {{ CONTAINER_NAME }}".to_owned(),
/// ),
/// (
/// "parameter in key: {{ OWNER }}".to_owned(),
/// "enum: {{ ACCESS_MODE }}".to_owned(),
/// ),
/// ("uuid".to_owned(), "{{ CONTAINER_UUID }}".to_owned()),
/// ("path".to_owned(), "{{ PATH }}".to_owned()),
/// ])).unwrap()),
/// None
/// );
/// let path = "/some/path".into();
/// let container = forest.create_container("container name1".to_owned(), &storage_template, path, false, "".into()).unwrap();
/// ```
#[tracing::instrument(level = "debug", skip_all)]
pub fn create_container(
&self,
container_name: String,
storage_template: &StorageTemplate,
path: ContainerPath,
encrypted: bool,
metadata: Vec<u8>,
) -> Result<Container, CoreXError> {
let container_uuid = Uuid::new_v4();
let RenderedStorage {
name,
backend_type,
data,
} = {
let template_context = TemplateContext {
container_name: container_name.clone(),
owner: self.forest_manifest.owner().hex_encode(),
access_mode: crate::StorageAccessMode::ReadWrite,
container_uuid,
path: path.clone(),
};
storage_template.render(template_context).map_err(|e| {
CoreXError::Generic(format!(
"Template render error while creating a container: {e}"
))
})?
};
let serialized_storage_specific_data = serde_json::to_value(data).map_err(|e| {
CoreXError::Generic(format!("Could not serialize rendered storage data: {e}"))
})?;
let storage = Storage::new(
Uuid::new_v4(),
name,
backend_type,
serialized_storage_specific_data,
encrypted,
storage_template.catlib_uuid(),
);
let container_data = ContainerData {
name: container_name,
metadata,
};
Ok(Container::new(
self.forest_manifest
.create_container(container_uuid, container_data.into(), path, vec![storage])
.context("Could not create a container in catlib")?,
))
}
#[tracing::instrument(level = "trace")]
pub fn find_containers(
&self,
filter: Option<CatlibContainerFilter>,
) -> Result<Vec<Container>, CatlibError> {
let containers = self.forest_manifest.find_containers(filter)?;
Ok(containers.into_iter().map(Container::new).collect())
}
/// ## Errors
///
/// Returns `RedisError` cast on [`crate::catlib_service::error::CatlibResult`] upon failure to save to the database.
pub fn add_device(&mut self, device: WildlandPubKey) -> Result<bool, CatlibError> {
self.forest_manifest.add_device(device, "".into()) // TODO CARGO-213
}
/// ## Errors
///
/// Returns `RedisError` cast on [`crate::catlib_service::error::CatlibResult`] upon failure to save to the database.
#[tracing::instrument(level = "debug", skip_all)]
pub fn delete_device(&self, device: WildlandPubKey) -> Result<bool, CatlibError> {
self.forest_manifest.delete_device(device)
}
/// Gets the current collection of the Forest's devices.
///
/// ## Errors
///
/// Returns `RedisError` cast on [`crate::catlib_service::error::CatlibResult`] upon failure to sync to the database.
pub fn devices(&mut self) -> Result<Devices, CatlibError> {
self.forest_manifest.devices()
}
/// ## Errors
///
/// Returns `RedisError` cast on [`crate::catlib_service::error::CatlibResult`] upon failure to save to the database.
#[tracing::instrument(level = "debug", skip_all)]
pub fn remove(self) -> Result<bool, CatlibError> {
self.forest_manifest.delete()
}
pub fn owner(&self) -> WildlandPubKey {
self.forest_manifest.owner()
}
}