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
use crate::{
error::{ParseError, Reason},
expression::{ExprNode, Expression, ExpressionReq, Operator},
lexer::{Lexer, Token},
LicenseItem, LicenseReq, ParseMode,
};
use smallvec::SmallVec;
impl Expression {
/// Given a license expression, attempts to parse and validate it as a valid
/// SPDX expression. Uses `ParseMode::Strict`.
///
/// The validation can fail for many reasons:
/// * The expression contains invalid characters
/// * An unknown/invalid license or exception identifier was found. Only
/// [SPDX short identifiers](https://spdx.org/ids) are allowed
/// * The expression contained unbalanced parentheses
/// * A license or exception immediately follows another license or exception, without
/// a valid AND, OR, or WITH operator separating them
/// * An AND, OR, or WITH doesn't have a license or `)` preceding it
///
/// ```
/// spdx::Expression::parse("MIT OR Apache-2.0 WITH LLVM-exception").unwrap();
/// ```
pub fn parse(original: &str) -> Result<Self, ParseError> {
Self::parse_mode(original, ParseMode::STRICT)
}
/// Parses an expression with the specified `ParseMode`. With
/// `ParseMode::Lax` it permits some non-SPDX syntax, such as imprecise
/// license names and "/" used instead of "OR" in exprssions.
///
/// ```
/// spdx::Expression::parse_mode(
/// "mit/Apache-2.0 WITH LLVM-exception",
/// spdx::ParseMode::LAX
/// ).unwrap();
/// ```
pub fn parse_mode(original: &str, mode: ParseMode) -> Result<Self, ParseError> {
// Operator precedence in SPDX 2.1
// +
// WITH
// AND
// OR
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug)]
enum Op {
//Plus,
//With,
And,
Or,
Open,
}
struct OpAndSpan {
op: Op,
span: std::ops::Range<usize>,
}
let lexer = Lexer::new_mode(original, mode);
let mut op_stack = SmallVec::<[OpAndSpan; 3]>::new();
let mut expr_queue = SmallVec::<[ExprNode; 5]>::new();
// Keep track of the last token to simplify validation of the token stream
let mut last_token: Option<Token<'_>> = None;
let apply_op = |op: OpAndSpan, q: &mut SmallVec<[ExprNode; 5]>| {
let op = match op.op {
Op::And => Operator::And,
Op::Or => Operator::Or,
Op::Open => unreachable!(),
};
q.push(ExprNode::Op(op));
Ok(())
};
let make_err_for_token = |last_token: Option<Token<'_>>, span: std::ops::Range<usize>| {
let expected: &[&str] = match last_token {
None | Some(Token::And | Token::Or | Token::OpenParen) => &["<license>", "("],
Some(Token::CloseParen) => &["AND", "OR"],
Some(Token::Exception(_)) => &["AND", "OR", ")"],
Some(Token::Spdx(_)) => &["AND", "OR", "WITH", ")", "+"],
Some(Token::LicenseRef { .. } | Token::Plus) => &["AND", "OR", "WITH", ")"],
Some(Token::With) => &["<exception>"],
};
Err(ParseError {
original: original.to_owned(),
span,
reason: Reason::Unexpected(expected),
})
};
// Basic implementation of the https://en.wikipedia.org/wiki/Shunting-yard_algorithm
'outer: for tok in lexer {
let lt = tok?;
match <.token {
Token::Spdx(id) => match last_token {
None | Some(Token::And | Token::Or | Token::OpenParen) => {
expr_queue.push(ExprNode::Req(ExpressionReq {
req: LicenseReq::from(*id),
span: lt.span.start as u32..lt.span.end as u32,
}));
}
_ => return make_err_for_token(last_token, lt.span),
},
Token::LicenseRef { doc_ref, lic_ref } => match last_token {
None | Some(Token::And | Token::Or | Token::OpenParen) => {
expr_queue.push(ExprNode::Req(ExpressionReq {
req: LicenseReq {
license: LicenseItem::Other {
doc_ref: doc_ref.map(String::from),
lic_ref: String::from(*lic_ref),
},
exception: None,
},
span: lt.span.start as u32..lt.span.end as u32,
}));
}
_ => return make_err_for_token(last_token, lt.span),
},
Token::Plus => match last_token {
Some(Token::Spdx(_)) => match expr_queue.last_mut().unwrap() {
ExprNode::Req(ExpressionReq {
req:
LicenseReq {
license: LicenseItem::Spdx { or_later, id },
..
},
..
}) => {
// Handle GNU licenses differently, as they should *NOT* be used with the `+`
if !mode.allow_postfix_plus_on_gpl && id.is_gnu() {
return Err(ParseError {
original: original.to_owned(),
span: lt.span,
reason: Reason::GnuNoPlus,
});
}
*or_later = true;
}
_ => unreachable!(),
},
_ => return make_err_for_token(last_token, lt.span),
},
Token::With => match last_token {
Some(Token::Spdx(_) | Token::LicenseRef { .. } | Token::Plus) => {}
_ => return make_err_for_token(last_token, lt.span),
},
Token::Or | Token::And => match last_token {
Some(
Token::Spdx(_)
| Token::LicenseRef { .. }
| Token::CloseParen
| Token::Exception(_)
| Token::Plus,
) => {
let new_op = match lt.token {
Token::Or => Op::Or,
Token::And => Op::And,
_ => unreachable!(),
};
while let Some(op) = op_stack.last() {
match &op.op {
Op::Open => break,
top => {
if *top < new_op {
let top = op_stack.pop().unwrap();
match top.op {
Op::And | Op::Or => apply_op(top, &mut expr_queue)?,
Op::Open => unreachable!(),
}
} else {
break;
}
}
}
}
op_stack.push(OpAndSpan {
op: new_op,
span: lt.span,
});
}
_ => return make_err_for_token(last_token, lt.span),
},
Token::OpenParen => match last_token {
None | Some(Token::And | Token::Or | Token::OpenParen) => {
op_stack.push(OpAndSpan {
op: Op::Open,
span: lt.span,
});
}
_ => return make_err_for_token(last_token, lt.span),
},
Token::CloseParen => {
match last_token {
Some(
Token::Spdx(_)
| Token::LicenseRef { .. }
| Token::Plus
| Token::Exception(_)
| Token::CloseParen,
) => {
while let Some(top) = op_stack.pop() {
match top.op {
Op::And | Op::Or => apply_op(top, &mut expr_queue)?,
Op::Open => {
// This is the only place we go back to the top of the outer loop,
// so make sure we correctly record this token
last_token = Some(Token::CloseParen);
continue 'outer;
}
}
}
// We didn't have an opening parentheses if we get here
return Err(ParseError {
original: original.to_owned(),
span: lt.span,
reason: Reason::UnopenedParens,
});
}
_ => return make_err_for_token(last_token, lt.span),
}
}
Token::Exception(exc) => match last_token {
Some(Token::With) => match expr_queue.last_mut() {
Some(ExprNode::Req(lic)) => {
lic.req.exception = Some(*exc);
}
_ => unreachable!(),
},
_ => return make_err_for_token(last_token, lt.span),
},
}
last_token = Some(lt.token);
}
// Validate that the terminating token is valid
match last_token {
Some(
Token::Spdx(_)
| Token::LicenseRef { .. }
| Token::Exception(_)
| Token::CloseParen
| Token::Plus,
) => {}
// We have to have at least one valid license requirement
None => {
return Err(ParseError {
original: original.to_owned(),
span: 0..original.len(),
reason: Reason::Empty,
});
}
Some(_) => return make_err_for_token(last_token, original.len()..original.len()),
}
while let Some(top) = op_stack.pop() {
match top.op {
Op::And | Op::Or => apply_op(top, &mut expr_queue)?,
Op::Open => {
return Err(ParseError {
original: original.to_owned(),
span: top.span,
reason: Reason::UnclosedParens,
});
}
}
}
// TODO: Investigate using https://github.com/oli-obk/quine-mc_cluskey to simplify
// expressions, but not really critical. Just cool.
Ok(Expression {
original: original.to_owned(),
expr: expr_queue,
})
}
}