kanidmd_lib/valueset/
iutf8.rs

1use super::iname::ValueSetIname;
2use crate::prelude::*;
3use crate::schema::SchemaAttribute;
4use crate::utils::trigraph_iter;
5use crate::valueset::ScimResolveStatus;
6use crate::valueset::{DbValueSetV2, ValueSet, ValueSetResolveStatus, ValueSetScimPut};
7use kanidm_proto::scim_v1::client::ScimStrings;
8use kanidm_proto::scim_v1::JsonValue;
9use std::collections::BTreeSet;
10
11#[derive(Debug, Clone)]
12pub struct ValueSetIutf8 {
13    set: BTreeSet<String>,
14}
15
16impl ValueSetIutf8 {
17    pub fn new(s: &str) -> Box<Self> {
18        let mut set = BTreeSet::new();
19        set.insert(s.to_lowercase());
20        Box::new(ValueSetIutf8 { set })
21    }
22
23    pub fn push(&mut self, s: &str) -> bool {
24        self.set.insert(s.to_lowercase())
25    }
26
27    pub fn from_dbvs2(data: Vec<String>) -> Result<ValueSet, OperationError> {
28        let set = data.into_iter().collect();
29        Ok(Box::new(ValueSetIutf8 { set }))
30    }
31
32    // We need to allow this, because rust doesn't allow us to impl FromIterator on foreign
33    // types, and str is foreign.
34    #[allow(clippy::should_implement_trait)]
35    pub fn from_iter<'a, T>(iter: T) -> Option<Box<Self>>
36    where
37        T: IntoIterator<Item = &'a str>,
38    {
39        let set = iter.into_iter().map(str::to_string).collect();
40        Some(Box::new(ValueSetIutf8 { set }))
41    }
42}
43
44impl ValueSetScimPut for ValueSetIutf8 {
45    fn from_scim_json_put(value: JsonValue) -> Result<ValueSetResolveStatus, OperationError> {
46        let ScimStrings(values) = serde_json::from_value(value).map_err(|err| {
47            error!(?err, "SCIM Iutf8 Syntax Invalid");
48            OperationError::SC0017Iutf8SyntaxInvalid
49        })?;
50
51        let set = values.iter().map(|s| s.to_lowercase()).collect();
52
53        Ok(ValueSetResolveStatus::Resolved(Box::new(ValueSetIutf8 {
54            set,
55        })))
56    }
57}
58
59impl ValueSetT for ValueSetIutf8 {
60    fn insert_checked(&mut self, value: Value) -> Result<bool, OperationError> {
61        match value {
62            Value::Iutf8(s) => Ok(self.set.insert(s)),
63            _ => {
64                debug_assert!(false);
65                Err(OperationError::InvalidValueState)
66            }
67        }
68    }
69
70    fn clear(&mut self) {
71        self.set.clear();
72    }
73
74    fn remove(&mut self, pv: &PartialValue, _cid: &Cid) -> bool {
75        match pv {
76            PartialValue::Iutf8(s) => self.set.remove(s),
77            _ => {
78                debug_assert!(false);
79                true
80            }
81        }
82    }
83
84    fn contains(&self, pv: &PartialValue) -> bool {
85        match pv {
86            PartialValue::Iutf8(s) => self.set.contains(s.as_str()),
87            _ => false,
88        }
89    }
90
91    fn substring(&self, pv: &PartialValue) -> bool {
92        match pv {
93            PartialValue::Iutf8(s2) => self.set.iter().any(|s1| s1.contains(s2)),
94            _ => {
95                debug_assert!(false);
96                false
97            }
98        }
99    }
100
101    fn startswith(&self, pv: &PartialValue) -> bool {
102        match pv {
103            PartialValue::Iutf8(s2) => self.set.iter().any(|s1| s1.starts_with(s2)),
104            _ => {
105                debug_assert!(false);
106                false
107            }
108        }
109    }
110
111    fn endswith(&self, pv: &PartialValue) -> bool {
112        match pv {
113            PartialValue::Iutf8(s2) => self.set.iter().any(|s1| s1.ends_with(s2)),
114            _ => {
115                debug_assert!(false);
116                false
117            }
118        }
119    }
120
121    fn lessthan(&self, _pv: &PartialValue) -> bool {
122        false
123    }
124
125    fn len(&self) -> usize {
126        self.set.len()
127    }
128
129    fn generate_idx_eq_keys(&self) -> Vec<String> {
130        self.set.iter().cloned().collect()
131    }
132
133    fn generate_idx_sub_keys(&self) -> Vec<String> {
134        let mut trigraphs: Vec<_> = self.set.iter().flat_map(|v| trigraph_iter(v)).collect();
135
136        trigraphs.sort_unstable();
137        trigraphs.dedup();
138
139        trigraphs.into_iter().map(String::from).collect()
140    }
141
142    fn syntax(&self) -> SyntaxType {
143        SyntaxType::Utf8StringInsensitive
144    }
145
146    fn validate(&self, _schema_attr: &SchemaAttribute) -> bool {
147        self.set.iter().all(|s| {
148            Value::validate_str_escapes(s) && Value::validate_singleline(s) &&
149                // I'm sure there is a better way ...
150                s.to_lowercase().as_str() == s.as_str()
151        })
152    }
153
154    fn to_proto_string_clone_iter(&self) -> Box<dyn Iterator<Item = String> + '_> {
155        Box::new(self.set.iter().cloned())
156    }
157
158    fn to_scim_value(&self) -> Option<ScimResolveStatus> {
159        let mut iter = self.set.iter().cloned();
160        if self.len() == 1 {
161            let v = iter.next().unwrap_or_default();
162            Some(v.into())
163        } else {
164            let arr = iter.collect::<Vec<_>>();
165            Some(arr.into())
166        }
167    }
168
169    fn to_db_valueset_v2(&self) -> DbValueSetV2 {
170        DbValueSetV2::Iutf8(self.set.iter().cloned().collect())
171    }
172
173    fn to_partialvalue_iter(&self) -> Box<dyn Iterator<Item = PartialValue> + '_> {
174        Box::new(self.set.iter().map(|i| PartialValue::new_iutf8(i.as_str())))
175    }
176
177    fn to_value_iter(&self) -> Box<dyn Iterator<Item = Value> + '_> {
178        Box::new(self.set.iter().map(|i| Value::new_iutf8(i.as_str())))
179    }
180
181    fn equal(&self, other: &ValueSet) -> bool {
182        if let Some(other) = other.as_iutf8_set() {
183            &self.set == other
184        } else {
185            debug_assert!(false);
186            false
187        }
188    }
189
190    fn merge(&mut self, other: &ValueSet) -> Result<(), OperationError> {
191        if let Some(b) = other.as_iutf8_set() {
192            mergesets!(self.set, b)
193        } else {
194            debug_assert!(false);
195            Err(OperationError::InvalidValueState)
196        }
197    }
198
199    fn to_iutf8_single(&self) -> Option<&str> {
200        if self.set.len() == 1 {
201            self.set.iter().take(1).next().map(|s| s.as_str())
202        } else {
203            None
204        }
205    }
206
207    fn as_iutf8_set(&self) -> Option<&BTreeSet<String>> {
208        Some(&self.set)
209    }
210
211    fn as_iutf8_iter(&self) -> Option<Box<dyn Iterator<Item = &str> + '_>> {
212        Some(Box::new(self.set.iter().map(|s| s.as_str())))
213    }
214
215    fn migrate_iutf8_iname(&self) -> Result<Option<ValueSet>, OperationError> {
216        let vsi: Option<ValueSet> =
217            ValueSetIname::from_iter(self.set.iter().map(|s| s.as_str())).map(|vs| vs as _);
218        Ok(vsi)
219    }
220}
221
222#[cfg(test)]
223mod tests {
224    use super::ValueSetIutf8;
225    use crate::prelude::ValueSet;
226
227    #[test]
228    fn test_scim_iutf8() {
229        let vs: ValueSet = ValueSetIutf8::new("lowercase string");
230        crate::valueset::scim_json_reflexive(&vs, r#""lowercase string""#);
231
232        // Test that we can parse json values into a valueset.
233        crate::valueset::scim_json_put_reflexive::<ValueSetIutf8>(&vs, &[])
234    }
235}