kanidmd_lib/valueset/
utf8.rs

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

kanidmd_lib/valueset/
utf8.rs
