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
//!
//! The query parser can turn a string that follows the Toql query syntax into a [Query](../query/struct.Query.html).
//!
//! ## Example
//! 
//! ``` ignore
//! let  query = QueryParser::parse("*, +username").unwrap();
//! assert_eq!("*, +username", query.to_string());
//! ```
//! Read the guide for more information on the query syntax.
//! 
//! The parser is written with [Pest](https://pest.rs/) and is fast. It should be used to parse query request from users. 
//! To build a query within your program, build it programmatically with the provided methods. 
//! This avoids typing mistakes and - unlike parsing - cannot fail.
//! 
use crate::query::Concatenation;
use crate::query::Field;
use crate::query::Wildcard;
use crate::query::FieldFilter;
use crate::query::FieldOrder;
use crate::query::Query;
use crate::query::QueryToken;
use pest::error::Error;
use pest::error::ErrorVariant::CustomError;
use pest::Parser;
use crate::error::ToqlError;

#[derive(Parser)]
#[grammar = "toql.pest"]
struct PestQueryParser;

/// The query parser. 
/// It contains only a single static method to turn a string into a Query struct.
pub struct QueryParser;

impl QueryParser {
    /// Method to parse a string
    /// This fails if the syntax is wrong. The original PEST error is wrapped with the ToqlError and 
    /// can be used to examine to problem in detail.
    pub fn parse(toql_string: &str) -> Result<Query, ToqlError> {
        let pairs = PestQueryParser::parse(Rule::query, toql_string)?;

        let mut query = Query::new();
        let mut con = Concatenation::And;

        for pair in pairs.flatten().into_iter() {
            let span = pair.clone().as_span();
            //   println!("Rule:    {:?}", pair.as_rule());
            //   println!("Span:    {:?}", span);
            //   println!("Text:    {}", span.as_str());
            match pair.as_rule() {
                Rule::field_clause => {
                    query.tokens.push(QueryToken::Field(Field {
                        concatenation: con.clone(),
                        name: "missing".to_string(),
                        hidden: false,
                        order: None,
                        aggregation: false,
                        filter: None,
                    }));
                }
                Rule::sort => {
                    let token = query.tokens.last_mut();
                    if let Some(t) = token {
                        if let QueryToken::Field(ref mut field) = t {
                            let p = span.as_str()[1..].parse::<u8>().unwrap_or(1);
                            if let Some('+') = span.as_str().chars().next() {
                                field.order = Some(FieldOrder::Asc(p));
                            } else {
                                field.order = Some(FieldOrder::Desc(p));
                            }
                        }
                    }
                }
                Rule::hidden => {
                    let token = query.tokens.last_mut();
                    if let Some(t) = token {
                        if let QueryToken::Field(ref mut field) = t {
                            field.hidden = true;
                        }
                    }
                }
                Rule::aggregation => {
                    let token = query.tokens.last_mut();
                    if let Some(t) = token {
                        if let QueryToken::Field(ref mut field) = t {
                            field.aggregation = true;
                        }
                    }
                }

                Rule::field_path => {
                    let token = query.tokens.last_mut();
                    if let Some(t) = token {
                        if let QueryToken::Field(ref mut field) = t {
                            field.name = span.as_str().to_string();
                        }
                    }
                }
                 Rule::wildcard_path => {
                    let token = query.tokens.last_mut();
                    if let Some(t) = token {
                        if let QueryToken::Wildcard(ref mut wildcard) = t {
                            wildcard.path = span.as_str().to_string();
                        }
                    }
                }
                Rule::field_filter => {
                    let token = query.tokens.last_mut();
                    if let Some(t) = token {
                        if let QueryToken::Field(ref mut field) = t {
                            let mut iter = span.as_str().split_whitespace();
                            let op = iter.next();

                            field.filter = match op.unwrap().to_uppercase().as_str() {
                                "EQ" => Some(FieldFilter::Eq(iter.next().unwrap().to_string())),
                                "EQN" => Some(FieldFilter::Eqn),
                                "NE" => Some(FieldFilter::Ne(iter.next().unwrap().to_string())),
                                "NEN" => Some(FieldFilter::Nen),
                                "GT" => Some(FieldFilter::Gt(iter.next().unwrap().to_string())),
                                "GE" => Some(FieldFilter::Ge(iter.next().unwrap().to_string())),
                                "LT" => Some(FieldFilter::Lt(iter.next().unwrap().to_string())),
                                "LE" => Some(FieldFilter::Le(iter.next().unwrap().to_string())),
                                "LK" => Some(FieldFilter::Lk(iter.next().unwrap().to_string())),
                                "IN" => Some(FieldFilter::In(iter.map(String::from).collect())),
                                "OUT" => Some(FieldFilter::Out(iter.map(String::from).collect())),
                                "BW" => Some(FieldFilter::Bw(
                                    iter.next().unwrap().to_string(),
                                    iter.next().unwrap().to_string(),
                                )),
                                "RE" => Some(FieldFilter::Re(iter.next().unwrap().to_string())),
                           //     "SC" => Some(FieldFilter::Sc(iter.next().unwrap().to_string())),
                                "FN" => Some(FieldFilter::Fn(
                                    iter.next().unwrap().to_string(),
                                    iter.map(String::from).collect(),
                                )),
                                _ => {
                                    return Err(ToqlError::QueryParserError(Error::new_from_span(
                                        CustomError {
                                            message: "Invalid filter Function".to_string(),
                                        },
                                        span,
                                    )))
                                }
                            }
                        }
                    }
                }
                Rule::double_wildcard => {
                    query.tokens.push(QueryToken::DoubleWildcard(con.clone()));
                }
                Rule::wildcard => {
                    query.tokens.push(QueryToken::Wildcard( 
                        Wildcard { 
                            concatenation: con.clone(), 
                            path: String::from("")
                        }));
                }
                Rule::rpar => {
                    query.tokens.push(QueryToken::RightBracket);
                }
                Rule::lpar => {
                    query.tokens.push(QueryToken::LeftBracket(con.clone()));
                }
                Rule::concat => {
                    if let Some(',') = span.as_str().chars().next() {
                        con = Concatenation::And;
                    } else {
                        con = Concatenation::Or;
                    }
                }

                _ => {}
            }
        }
        Ok(query)
    }
}