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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
#![deny(
//    missing_docs,
    missing_debug_implementations,
    missing_copy_implementations,
    trivial_casts,
    trivial_numeric_casts,
    unsafe_code,
    unstable_features,
    unused_import_braces,
    unused_qualifications
)]

use serde::ser::{SerializeStruct, Serializer};
use serde::Serialize;
use Reference;
use Snak;
use SnakDataType;
use WikibaseError;

/// Statement Rank
///
/// The rank each statement has on Wikidata. Default is Normal.
/// https://www.wikidata.org/wiki/Help:Ranking
#[derive(Debug, Clone, PartialEq, Copy)]
pub enum StatementRank {
    Deprecated,
    Normal,
    Preferred,
}

impl StatementRank {
    pub fn as_str(&self) -> &str {
        match self {
            StatementRank::Deprecated => "deprecated",
            StatementRank::Normal => "normal",
            StatementRank::Preferred => "preferred",
        }
    }
}

/// Statement
///
/// A Wikidata statement has a main statement (the `main_snak`),
/// and qualifiers and references. In Wikidata terminology
/// only a claim with references is a statement.
#[derive(Debug, Clone)]
pub struct Statement {
    claim_type: String,
    rank: StatementRank,
    main_snak: Snak,
    qualifiers: Vec<Snak>,
    references: Vec<Reference>,
    id: Option<String>,
}

impl Statement {
    pub fn new<S: Into<String>>(
        claim_type: S,
        rank: StatementRank,
        main_snak: Snak,
        qualifiers: Vec<Snak>,
        references: Vec<Reference>,
    ) -> Statement {
        Self {
            claim_type: claim_type.into(),
            rank,
            main_snak,
            qualifiers,
            references,
            id: None,
        }
    }

    pub fn new_normal(
        main_snak: Snak,
        qualifiers: Vec<Snak>,
        references: Vec<Reference>,
    ) -> Statement {
        Self::new(
            "statement",
            StatementRank::Normal,
            main_snak,
            qualifiers,
            references,
        )
    }

    /// Serializes a Wikidata claim
    ///
    /// Takes a json object and returns a result.
    ///
    /// # Errors
    ///
    /// An error is returned when the json can't be interpreted as an object,
    /// or the main snak is missing.
    pub fn new_from_json(json_claim: &serde_json::Value) -> Result<Statement, WikibaseError> {
        let claim_object = match &json_claim.as_object() {
            &Some(value) => value,
            &None => return Err(WikibaseError::Serialization("Statement".to_string())),
        };

        let claim_type = match claim_object["type"].as_str() {
            Some(value) => value,
            None => {
                return Err(WikibaseError::Serialization(
                    "Statement type error".to_string(),
                ));
            }
        };

        let rank_string = match claim_object["rank"].as_str() {
            Some(value) => value,
            None => {
                return Err(WikibaseError::Serialization(
                    "Statement rank error".to_string(),
                ));
            }
        };

        let rank = match rank_string {
            "deprecated" => StatementRank::Deprecated,
            "normal" => StatementRank::Normal,
            "preferred" => StatementRank::Preferred,
            _ => {
                return Err(WikibaseError::Serialization(
                    "Statement rank error".to_string(),
                ));
            }
        };

        let main_snak = match &claim_object["mainsnak"].as_object() {
            &Some(snak_json) => Snak::new_from_json(snak_json)?,
            &None => return Err(WikibaseError::Serialization("Main snak".to_string())),
        };

        let qualifiers = match &claim_object.get("qualifiers") {
            // Qualifiers are an object with property keys that contain
            // an array of snaks. {"P817": [], ...}
            &Some(qualifiers) => Statement::snaks_object_from_json(&qualifiers)?,
            &None => vec![],
        };

        let references = match &claim_object.get("references") {
            &Some(references_array_json) => {
                Statement::reference_array_from_json(&references_array_json)?
            }
            &None => vec![],
        };

        let mut statement = Statement::new(claim_type, rank, main_snak, qualifiers, references);

        // Set statement ID, if present

        match claim_object["id"].as_str() {
            Some(id) => statement.set_id(id.to_string()),
            None => {}
        };

        Ok(statement)
    }

    /// Serializes an object of snaks from JSON
    ///
    /// Wikibase uses this structure for qualfiers and the references.
    ///
    /// # JSON Documentation
    ///
    /// Serializes a json that looks like this:
    ///
    /// `
    /// {"qualifiers": {"P1": [Snak1, Snak2], ... ]}}
    /// `
    pub fn snaks_object_from_json(
        snaks_object_json: &serde_json::Value,
    ) -> Result<Vec<Snak>, WikibaseError> {
        let mut snaks = vec![];

        let snaks_object = match &snaks_object_json.as_object() {
            &Some(value) => value,
            &None => {
                return Err(WikibaseError::Serialization(
                    "Can't deserialize snaks object".to_string(),
                ));
            }
        };

        // Loop over the property keys e.g. {"P817": [], ...}
        for (_, property_snaks) in snaks_object.iter() {
            let snak_array = match &property_snaks.as_array() {
                &Some(value) => value,
                &None => {
                    return Err(WikibaseError::Serialization(
                        "Can't deserialize snak array".to_string(),
                    ));
                }
            };

            // Loop over the qualifiers of one property e.g. {"P817": [Snak-A, Snak-B, ...]}
            for snak_json in snak_array.iter() {
                let snak_object = match &snak_json.as_object() {
                    &Some(value) => value,
                    &None => {
                        return Err(WikibaseError::Serialization(
                            "Can't deserialize snak object".to_string(),
                        ));
                    }
                };

                snaks.push(Snak::new_from_json(snak_object)?);
            }
        }

        Ok(snaks)
    }

    /// Serializes the references of a claim
    ///
    /// Takes a serde-JSON value an returns a vector of references or an error
    /// inside of a result. The JSON looks like this:
    /// {"references": ["0": {"snaks": {"P1": [Snak1, Snak2]}, ... }]}
    pub fn reference_array_from_json(
        references_array_json: &serde_json::Value,
    ) -> Result<Vec<Reference>, WikibaseError> {
        let mut references = vec![];

        let reference_array = match &references_array_json.as_array() {
            &Some(value) => value,
            &None => return Err(WikibaseError::Serialization("Reference array".to_string())),
        };

        for references_object_json in reference_array.iter() {
            let reference_object = match &references_object_json.as_object() {
                &Some(value) => value,
                &None => return Err(WikibaseError::Serialization("Reference object".to_string())),
            };

            let snaks_array = match &reference_object.get("snaks") {
                &Some(value) => value,
                &None => {
                    return Err(WikibaseError::Serialization(
                        "Reference snak object".to_string(),
                    ));
                }
            };

            references.push(Reference::new(Self::snaks_object_from_json(snaks_array)?));
        }

        Ok(references)
    }

    /// Returns serde_json object, but with ID, hashes etc. removed
    pub fn as_stripped_json(&self) -> serde_json::Value {
        let mut ret = json!(self);
        // TODO strip hashes etc.
        if ret.as_object().unwrap().contains_key("id") {
            ret.as_object_mut().unwrap().remove("id").unwrap();
        }
        ret
    }

    pub fn set_id<S: Into<String>>(&mut self, id: S) {
        self.id = Some(id.into());
    }

    pub fn id(&self) -> Option<String> {
        self.id.clone()
    }

    pub fn set_claim_type(&mut self, claim_type: &str) {
        self.claim_type = claim_type.to_string();
    }

    pub fn set_rank(&mut self, rank: StatementRank) {
        self.rank = rank;
    }

    pub fn set_datatype(&mut self, datatype: SnakDataType) {
        self.main_snak.set_datatype(datatype);
    }

    pub fn property(&self) -> &str {
        &self.main_snak.property()
    }

    pub fn set_property(&mut self, property: &str) {
        self.main_snak.set_property(property);
    }

    pub fn set_main_snak(&mut self, snak: Snak) {
        self.main_snak = snak;
    }

    pub fn add_qualifier_snak(&mut self, snak: Snak) {
        self.qualifiers.push(snak);
    }

    pub fn set_qualifier_snaks(&mut self, snaks: Vec<Snak>) {
        self.qualifiers = snaks;
    }

    pub fn set_references(&mut self, references: Vec<Reference>) {
        self.references = references;
    }

    pub fn references(&self) -> &Vec<Reference> {
        &self.references
    }

    pub fn qualifiers(&self) -> &Vec<Snak> {
        &self.qualifiers
    }

    pub fn main_snak(&self) -> &Snak {
        &self.main_snak
    }

    pub fn claim_type(&self) -> &String {
        &self.claim_type
    }

    pub fn rank(&self) -> &StatementRank {
        &self.rank
    }
}

impl Serialize for Statement {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let mut num = 3;
        if self.id.is_some() {
            num += 1;
        }
        if !self.qualifiers.is_empty() {
            num += 1;
        }
        if !self.references.is_empty() {
            num += 1;
        }
        let mut state = serializer.serialize_struct("Statement", num)?;

        state.serialize_field("type", &self.claim_type)?;
        state.serialize_field("rank", &self.rank.as_str())?;
        state.serialize_field("mainsnak", &self.main_snak)?;

        match &self.id {
            Some(id) => state.serialize_field("id", &id)?,
            None => {}
        };

        if !self.qualifiers.is_empty() {
            let mut qualifiers = json!({});
            for snak in &self.qualifiers {
                if !qualifiers[snak.property()].is_object() {
                    qualifiers[snak.property()] = json!([]);
                }
                qualifiers[snak.property()]
                    .as_array_mut()
                    .unwrap()
                    .push(json!(snak));
            }
            state.serialize_field("qualifiers", &qualifiers)?;
        }

        if !self.references.is_empty() {
            let mut references = json!([]);
            for reference in &self.references {
                let mut rj = json!({"snaks":{}});
                for snak in reference.snaks() {
                    if !rj["snaks"][snak.property()].is_array() {
                        rj["snaks"][snak.property()] = json!([]);
                    }
                    rj["snaks"][snak.property()]
                        .as_array_mut()
                        .unwrap()
                        .push(json!(snak));
                }
                // TODO: "snaks-order"?
                references.as_array_mut().unwrap().push(rj);
            }
            state.serialize_field("references", &references)?;
        }

        state.end()
    }
}