oxirs-core 0.2.3

Core RDF and SPARQL functionality for OxiRS - native Rust implementation with zero dependencies
Documentation
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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
//! SPARQL query parser
//!
//! This is a placeholder implementation that will be enhanced with full
//! SPARQL 1.1 parsing capabilities in future iterations.

use crate::model::{BlankNode, Literal, NamedNode, Variable};
use crate::query::algebra::{AlgebraTriplePattern, TermPattern as AlgebraTermPattern};
use crate::query::sparql_algebra::{GraphPattern, TermPattern, TriplePattern};
use crate::query::sparql_query::Query;
use crate::OxirsError;
use std::collections::HashMap;

/// A SPARQL parser
#[derive(Debug, Clone, Default)]
pub struct SparqlParser {
    base_iri: Option<NamedNode>,
    prefixes: HashMap<String, NamedNode>,
}

impl SparqlParser {
    /// Creates a new SPARQL parser
    pub fn new() -> Self {
        Self::default()
    }

    /// Sets the base IRI for resolving relative IRIs
    pub fn with_base_iri(mut self, base_iri: impl Into<String>) -> Result<Self, OxirsError> {
        self.base_iri = Some(NamedNode::new(base_iri.into())?);
        Ok(self)
    }

    /// Adds a prefix mapping
    pub fn with_prefix(
        mut self,
        prefix: impl Into<String>,
        iri: impl Into<String>,
    ) -> Result<Self, OxirsError> {
        self.prefixes
            .insert(prefix.into(), NamedNode::new(iri.into())?);
        Ok(self)
    }

    /// Parses a SPARQL query string - alias for parse_query
    pub fn parse(&self, query: &str) -> Result<Query, OxirsError> {
        self.parse_query(query)
    }

    /// Parses a SPARQL query string
    pub fn parse_query(&self, query: &str) -> Result<Query, OxirsError> {
        // This is a simplified parser for demonstration
        // Full implementation would use a proper parser generator

        let query = query.trim();

        // Very basic SELECT query detection
        if query.to_uppercase().starts_with("SELECT") {
            self.parse_select_query(query)
        } else if query.to_uppercase().starts_with("CONSTRUCT") {
            self.parse_construct_query(query)
        } else if query.to_uppercase().starts_with("ASK") {
            self.parse_ask_query(query)
        } else if query.to_uppercase().starts_with("DESCRIBE") {
            self.parse_describe_query(query)
        } else {
            Err(OxirsError::Parse(
                "Unsupported query form. Query must start with SELECT, CONSTRUCT, ASK, or DESCRIBE"
                    .to_string(),
            ))
        }
    }

    // Private helper methods for parsing different query forms

    fn parse_select_query(&self, query: &str) -> Result<Query, OxirsError> {
        // Extract WHERE clause (simplified parsing)
        let where_start = query
            .to_uppercase()
            .find("WHERE")
            .ok_or_else(|| OxirsError::Parse("SELECT query must have WHERE clause".to_string()))?;

        // Parse WHERE clause (simplified - just extract triple patterns)
        let pattern = self.parse_where_clause(&query[where_start + 5..])?;

        Ok(Query::Select {
            dataset: None,
            pattern,
            base_iri: self.base_iri.as_ref().map(|iri| iri.as_str().to_string()),
        })
    }

    fn parse_construct_query(&self, query: &str) -> Result<Query, OxirsError> {
        // Find CONSTRUCT template and WHERE clause
        let construct_start = query
            .to_uppercase()
            .find("CONSTRUCT")
            .expect("CONSTRUCT keyword should be present in construct query")
            + 9;
        let where_start = query.to_uppercase().find("WHERE").ok_or_else(|| {
            OxirsError::Parse("CONSTRUCT query must have WHERE clause".to_string())
        })?;

        // Parse template (simplified - just get the content between braces)
        let construct_clause = query[construct_start..where_start].trim();
        let algebra_template = self.parse_construct_template(construct_clause)?;
        let template: Vec<TriplePattern> = algebra_template
            .iter()
            .map(|p| self.convert_triple_pattern(p))
            .collect();

        // Parse WHERE clause
        let pattern = self.parse_where_clause(&query[where_start + 5..])?;

        Ok(Query::Construct {
            template,
            dataset: None,
            pattern,
            base_iri: self.base_iri.as_ref().map(|iri| iri.as_str().to_string()),
        })
    }

    fn parse_ask_query(&self, query: &str) -> Result<Query, OxirsError> {
        let where_start = query
            .to_uppercase()
            .find("WHERE")
            .ok_or_else(|| OxirsError::Parse("ASK query must have WHERE clause".to_string()))?;

        let pattern = self.parse_where_clause(&query[where_start + 5..])?;

        Ok(Query::Ask {
            dataset: None,
            pattern,
            base_iri: self.base_iri.as_ref().map(|iri| iri.as_str().to_string()),
        })
    }

    fn parse_describe_query(&self, query: &str) -> Result<Query, OxirsError> {
        let where_start = query.to_uppercase().find("WHERE").ok_or_else(|| {
            OxirsError::Parse("DESCRIBE query must have WHERE clause".to_string())
        })?;

        let pattern = self.parse_where_clause(&query[where_start + 5..])?;

        Ok(Query::Describe {
            dataset: None,
            pattern,
            base_iri: self.base_iri.as_ref().map(|iri| iri.as_str().to_string()),
        })
    }

    fn parse_construct_template(
        &self,
        template_text: &str,
    ) -> Result<Vec<AlgebraTriplePattern>, OxirsError> {
        let content = template_text.trim();
        if !content.starts_with('{') || !content.ends_with('}') {
            return Err(OxirsError::Parse(
                "CONSTRUCT template must be enclosed in {}".to_string(),
            ));
        }

        let content = content[1..content.len() - 1].trim();
        let mut triple_patterns: Vec<AlgebraTriplePattern> = Vec::new();

        // Split by periods, but respect IRI brackets
        let triple_strings = self.split_triples_by_period(content);

        for triple_str in triple_strings {
            let triple_str = triple_str.trim();
            if triple_str.is_empty() || triple_str.starts_with("FILTER") {
                continue;
            }

            // Parse triple pattern (subject predicate object)
            let parts: Vec<&str> = triple_str.split_whitespace().collect();
            if parts.len() < 3 {
                return Err(OxirsError::Parse(format!(
                    "Invalid triple pattern: '{triple_str}'"
                )));
            }

            let subject = self.parse_term_pattern(parts[0])?;
            let predicate = self.parse_term_pattern(parts[1])?;
            let object = self.parse_term_pattern(parts[2])?;

            // Validate subject pattern (literals can't be subjects)
            if matches!(subject, TermPattern::Literal(_)) {
                return Err(OxirsError::Parse("Literals cannot be subjects".to_string()));
            }

            // Validate predicate pattern (only named nodes and variables allowed)
            if !matches!(
                predicate,
                TermPattern::NamedNode(_) | TermPattern::Variable(_)
            ) {
                return Err(OxirsError::Parse(
                    "Predicates must be named nodes or variables".to_string(),
                ));
            }

            // Convert sparql_algebra::TermPattern to algebra::TermPattern
            let algebra_subject = self.convert_to_algebra_term(&subject)?;
            let algebra_predicate = self.convert_to_algebra_term(&predicate)?;
            let algebra_object = self.convert_to_algebra_term(&object)?;

            triple_patterns.push(AlgebraTriplePattern::new(
                algebra_subject,
                algebra_predicate,
                algebra_object,
            ));
        }

        Ok(triple_patterns)
    }

    // Helper method to convert sparql_algebra::TermPattern to algebra::TermPattern
    fn convert_to_algebra_term(
        &self,
        term: &TermPattern,
    ) -> Result<AlgebraTermPattern, OxirsError> {
        match term {
            TermPattern::NamedNode(n) => Ok(AlgebraTermPattern::NamedNode(n.clone())),
            TermPattern::BlankNode(b) => Ok(AlgebraTermPattern::BlankNode(b.clone())),
            TermPattern::Literal(l) => Ok(AlgebraTermPattern::Literal(l.clone())),
            TermPattern::Variable(v) => Ok(AlgebraTermPattern::Variable(v.clone())),
            #[cfg(feature = "sparql-12")]
            TermPattern::Triple(_) => Err(OxirsError::Parse(
                "Quoted triples not supported in construct templates".to_string(),
            )),
        }
    }

    fn parse_where_clause(&self, where_text: &str) -> Result<GraphPattern, OxirsError> {
        // Very simplified parsing - just extract basic triple patterns
        let content = where_text.trim();
        if !content.starts_with('{') || !content.ends_with('}') {
            return Err(OxirsError::Parse(
                "WHERE clause must be enclosed in {}".to_string(),
            ));
        }

        let content = content[1..content.len() - 1].trim();
        let mut triple_patterns: Vec<TriplePattern> = Vec::new();

        // Split by periods, but respect IRI brackets
        let triple_strings = self.split_triples_by_period(content);

        for triple_str in triple_strings {
            let triple_str = triple_str.trim();
            if triple_str.is_empty() || triple_str.starts_with("FILTER") {
                continue;
            }

            // Parse triple pattern (subject predicate object)
            let parts: Vec<&str> = triple_str.split_whitespace().collect();
            if parts.len() < 3 {
                return Err(OxirsError::Parse(format!(
                    "Invalid triple pattern: '{triple_str}'"
                )));
            }

            let subject = self.parse_term_pattern(parts[0])?;
            let predicate = self.parse_term_pattern(parts[1])?;
            let object = self.parse_term_pattern(parts[2])?;

            triple_patterns.push(TriplePattern::new(subject, predicate, object));
        }

        Ok(GraphPattern::Bgp {
            patterns: triple_patterns,
        })
    }

    fn parse_term_pattern(&self, term: &str) -> Result<TermPattern, OxirsError> {
        if term.starts_with('?') || term.starts_with('$') {
            Variable::new(term).map(TermPattern::Variable)
        } else if term.starts_with('<') && term.ends_with('>') {
            let iri = &term[1..term.len() - 1];
            NamedNode::new(iri).map(TermPattern::NamedNode)
        } else if term.starts_with('"') && term.ends_with('"') {
            let value = &term[1..term.len() - 1];
            Ok(TermPattern::Literal(Literal::new(value)))
        } else if term.starts_with("_:") {
            BlankNode::new(term).map(TermPattern::BlankNode)
        } else if let Some(colon_pos) = term.find(':') {
            // Prefixed name
            let prefix = &term[..colon_pos];
            let local = &term[colon_pos + 1..];

            if let Some(namespace) = self.prefixes.get(prefix) {
                let iri = format!("{}{}", namespace.as_str(), local);
                NamedNode::new(iri).map(TermPattern::NamedNode)
            } else {
                Err(OxirsError::Parse(format!("Unknown prefix: {prefix}")))
            }
        } else {
            Err(OxirsError::Parse(format!("Invalid term pattern: {term}")))
        }
    }

    /// Convert algebra TermPattern to sparql_algebra TermPattern
    fn convert_term_pattern(&self, term: &AlgebraTermPattern) -> TermPattern {
        match term {
            AlgebraTermPattern::NamedNode(n) => TermPattern::NamedNode(n.clone()),
            AlgebraTermPattern::BlankNode(b) => TermPattern::BlankNode(b.clone()),
            AlgebraTermPattern::Literal(l) => TermPattern::Literal(l.clone()),
            AlgebraTermPattern::Variable(v) => TermPattern::Variable(v.clone()),
            AlgebraTermPattern::QuotedTriple(_) => {
                panic!("RDF-star quoted triples not yet supported in SPARQL algebra conversion")
            }
        }
    }

    /// Convert AlgebraTriplePattern to sparql_algebra TriplePattern
    fn convert_triple_pattern(&self, pattern: &AlgebraTriplePattern) -> TriplePattern {
        TriplePattern::new(
            self.convert_term_pattern(&pattern.subject),
            self.convert_term_pattern(&pattern.predicate),
            self.convert_term_pattern(&pattern.object),
        )
    }

    /// Convert sparql_algebra TermPattern back to algebra TermPattern
    #[allow(clippy::only_used_in_recursion)]
    fn convert_term_pattern_back(&self, term: &TermPattern) -> AlgebraTermPattern {
        match term {
            TermPattern::NamedNode(n) => AlgebraTermPattern::NamedNode(n.clone()),
            TermPattern::BlankNode(b) => AlgebraTermPattern::BlankNode(b.clone()),
            TermPattern::Literal(l) => AlgebraTermPattern::Literal(l.clone()),
            TermPattern::Variable(v) => AlgebraTermPattern::Variable(v.clone()),
            #[cfg(feature = "sparql-12")]
            TermPattern::Triple(triple_pattern) => {
                // RDF-star: Triple patterns in term position (quoted triples)
                // Convert the nested triple pattern recursively
                let subject = self.convert_term_pattern_back(&triple_pattern.subject);
                let predicate = self.convert_term_pattern_back(&triple_pattern.predicate);
                let object = self.convert_term_pattern_back(&triple_pattern.object);

                // Create a quoted triple pattern (RDF-star feature)
                // This represents a triple that appears as a term in another triple
                AlgebraTermPattern::QuotedTriple(Box::new(crate::query::AlgebraTriplePattern::new(
                    subject, predicate, object,
                )))
            }
        }
    }

    /// Convert sparql_algebra TriplePattern back to AlgebraTriplePattern
    pub fn convert_triple_pattern_back(&self, pattern: &TriplePattern) -> AlgebraTriplePattern {
        AlgebraTriplePattern::new(
            self.convert_term_pattern_back(&pattern.subject),
            self.convert_term_pattern_back(&pattern.predicate),
            self.convert_term_pattern_back(&pattern.object),
        )
    }

    /// Split triples by period while respecting IRI brackets
    fn split_triples_by_period(&self, content: &str) -> Vec<String> {
        let mut triples = Vec::new();
        let mut current = String::new();
        let mut in_iri = false;
        let mut in_literal = false;
        let mut escape_next = false;

        for ch in content.chars() {
            if escape_next {
                current.push(ch);
                escape_next = false;
                continue;
            }

            match ch {
                '\\' => {
                    escape_next = true;
                    current.push(ch);
                }
                '<' if !in_literal => {
                    in_iri = true;
                    current.push(ch);
                }
                '>' if in_iri && !in_literal => {
                    in_iri = false;
                    current.push(ch);
                }
                '"' => {
                    in_literal = !in_literal;
                    current.push(ch);
                }
                '.' if !in_iri && !in_literal => {
                    // End of triple
                    let trimmed = current.trim();
                    if !trimmed.is_empty() {
                        triples.push(trimmed.to_string());
                    }
                    current.clear();
                }
                _ => {
                    current.push(ch);
                }
            }
        }

        // Don't forget the last triple if there's no trailing period
        let trimmed = current.trim();
        if !trimmed.is_empty() {
            triples.push(trimmed.to_string());
        }

        triples
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_simple_select_query() {
        let parser = SparqlParser::new();
        let query = "SELECT ?s ?p ?o WHERE { ?s ?p ?o . }";
        let result = parser.parse_query(query);
        assert!(result.is_ok());

        if let Ok(Query::Select { pattern, .. }) = result {
            match pattern {
                GraphPattern::Bgp { patterns } => {
                    assert_eq!(patterns.len(), 1);
                    // Verify it's a triple pattern with variables
                    let triple = &patterns[0];
                    assert!(matches!(triple.subject, TermPattern::Variable(_)));
                    assert!(matches!(triple.predicate, TermPattern::Variable(_)));
                    assert!(matches!(triple.object, TermPattern::Variable(_)));
                }
                _ => panic!("Expected BGP pattern"),
            }
        } else {
            panic!("Expected SELECT query");
        }
    }

    #[test]
    fn test_ask_query() {
        let parser = SparqlParser::new();
        let query = "ASK WHERE { ?s ?p ?o . }";
        let result = parser.parse_query(query);
        assert!(result.is_ok());

        if let Ok(Query::Ask { pattern, .. }) = result {
            match pattern {
                GraphPattern::Bgp { patterns } => {
                    assert_eq!(patterns.len(), 1);
                }
                _ => panic!("Expected BGP pattern"),
            }
        } else {
            panic!("Expected ASK query");
        }
    }

    #[test]
    fn test_construct_query() {
        let parser = SparqlParser::new();
        let query = "CONSTRUCT { ?s ?p ?o } WHERE { ?s ?p ?o . }";
        let result = parser.parse_query(query);
        assert!(result.is_ok());

        if let Ok(Query::Construct {
            template, pattern, ..
        }) = result
        {
            assert_eq!(template.len(), 1);
            match pattern {
                GraphPattern::Bgp { patterns } => {
                    assert_eq!(patterns.len(), 1);
                }
                _ => panic!("Expected BGP pattern"),
            }
        } else {
            panic!("Expected CONSTRUCT query");
        }
    }

    #[test]
    fn test_parse_with_prefix() {
        let parser = SparqlParser::new()
            .with_prefix("ex", "http://example.org/")
            .expect("operation should succeed");

        let query = "SELECT ?s WHERE { ex:subject ?p ?o . }";
        let result = parser.parse_query(query);
        assert!(result.is_ok());
    }

    #[test]
    fn test_invalid_query() {
        let parser = SparqlParser::new();
        let query = "INVALID QUERY";
        let result = parser.parse_query(query);
        assert!(result.is_err());
    }
}