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
use std::ops::{Deref, DerefMut};
use std::str::FromStr;
use std::{collections::HashMap, fmt};
use crate::{bail, ensure};
/// An ADO.net connection string.
///
/// Keywords are not case-sensitive. Values, however, may be case-sensitive,
/// depending on the data source. Both keywords and values may contain whitespace
/// characters.
///
/// # Limitations
///
/// This parser does not support [Excel connection strings with extended properties](https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-string-syntax#connecting-to-excel).
///
/// [Read more](https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-string-syntax)
#[derive(Debug)]
pub struct AdoNetString {
pairs: HashMap<String, String>,
}
impl Deref for AdoNetString {
type Target = HashMap<String, String>;
fn deref(&self) -> &Self::Target {
&self.pairs
}
}
impl DerefMut for AdoNetString {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.pairs
}
}
// NOTE(yosh): Unfortunately we can't parse using `split(';')` because JDBC
// strings support escaping. This means that `{;}` is valid and we need to write
// an actual LR parser.
impl FromStr for AdoNetString {
type Err = crate::Error;
fn from_str(input: &str) -> Result<Self, Self::Err> {
let mut lexer = Lexer::tokenize(input)?;
let mut pairs = HashMap::new();
// Iterate over `key=value` pairs.
for n in 0.. {
// [property=[value][;property=value][;]]
// ^
if lexer.peek().kind() == &TokenKind::Eof {
break;
}
// [property=[value][;property=value][;]]
// ^
if n != 0 {
let err = "Key-value pairs must be separated by a `;`";
ensure!(lexer.next().kind() == &TokenKind::Semi, err);
// [property=value[;property=value][;]]
// ^
if lexer.peek().kind() == &TokenKind::Eof {
break;
}
}
// [property=[value][;property=value][;]]
// ^^^^^^^^
let key = read_ident(&mut lexer)?;
ensure!(!key.is_empty(), "Key must not be empty");
// [property=[value][;property=value][;]]
// ^
let err = "key-value pairs must be joined by a `=`";
ensure!(lexer.next().kind() == &TokenKind::Eq, err);
// [property=[value][;property=value][;]]
// ^^^^^
let value = read_ident(&mut lexer)?;
let key = key.to_lowercase();
pairs.insert(key, value);
}
Ok(Self { pairs })
}
}
impl fmt::Display for AdoNetString {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
/// Escape all non-alphanumeric characters in a string..
fn escape(s: &str) -> String {
let mut output = String::with_capacity(s.len());
let mut escaping = false;
for b in s.chars() {
if matches!(b, ':' | '=' | '\\' | '/' | ';' | '{' | '}' | '[' | ']') {
if !escaping {
escaping = true;
output.push('{');
}
output.push(b);
} else {
if escaping {
escaping = false;
output.push('}');
}
output.push(b);
}
}
if escaping {
output.push('}');
}
output
}
let total_pairs = self.pairs.len();
for (i, (k, v)) in self.pairs.iter().enumerate() {
write!(f, "{}={}", escape(k.trim()), escape(v.trim()))?;
if i < total_pairs - 1 {
write!(f, ";")?;
}
}
Ok(())
}
}
/// Read either a valid key or value from the lexer.
fn read_ident(lexer: &mut Lexer) -> crate::Result<String> {
let mut output = String::new();
loop {
let Token { kind, .. } = lexer.peek();
match kind {
TokenKind::Atom(c) => {
let _ = lexer.next();
output.push(c);
}
TokenKind::Escaped(seq) => {
let _ = lexer.next();
output.extend(seq);
}
TokenKind::Semi => break,
TokenKind::Eq => break,
TokenKind::Newline => {
let _ = lexer.next();
continue; // NOTE(yosh): unsure if this is the correct behavior
}
TokenKind::Whitespace => {
let _ = lexer.next();
match output.len() {
0 => continue, // ignore leading whitespace
_ => output.push(' '),
}
}
TokenKind::Eof => break,
}
}
output = output.trim_end().to_owned(); // remove trailing whitespace
Ok(output)
}
#[derive(Debug, Clone)]
struct Token {
kind: TokenKind,
#[allow(dead_code)] // for future use...
loc: Location,
}
impl Token {
/// Create a new instance.
fn new(kind: TokenKind, loc: Location) -> Self {
Self { kind, loc }
}
fn kind(&self) -> &TokenKind {
&self.kind
}
}
#[derive(Debug, Clone, Eq, PartialEq)]
enum TokenKind {
Semi,
Eq,
Atom(char),
Escaped(Vec<char>),
Newline,
Whitespace,
Eof,
}
#[derive(Debug)]
struct Lexer {
tokens: Vec<Token>,
}
impl Lexer {
/// Parse a string into a sequence of tokens.
fn tokenize(mut input: &str) -> crate::Result<Self> {
let mut tokens = vec![];
let mut loc = Location::default();
while !input.is_empty() {
let old_input = input;
let mut chars = input.chars();
let kind = match chars.next().unwrap() {
'"' => {
let mut buf = Vec::new();
loop {
match chars.next() {
None => bail!("unclosed double quote"),
// When we read a double quote inside a double quote
// we need to lookahead to determine whether it's an
// escape sequence or a closing delimiter.
Some('"') => match lookahead(&chars) {
Some('"') => {
if buf.is_empty() {
break;
}
let _ = chars.next();
buf.push('"');
buf.push('"');
}
Some(_) | None => break,
},
Some(c) if c.is_ascii() => buf.push(c),
_ => bail!("Invalid ado.net token"),
}
}
TokenKind::Escaped(buf)
}
'\'' => {
let mut buf = Vec::new();
loop {
match chars.next() {
None => bail!("unclosed single quote"),
// When we read a single quote inside a single quote
// we need to lookahead to determine whether it's an
// escape sequence or a closing delimiter.
Some('\'') => match lookahead(&chars) {
Some('\'') => {
if buf.is_empty() {
break;
}
let _ = chars.next();
buf.push('\'');
buf.push('\'');
}
Some(_) | None => break,
},
Some(c) if c.is_ascii() => buf.push(c),
Some(c) => bail!("Invalid ado.net token `{}`", c),
}
}
TokenKind::Escaped(buf)
}
'{' => {
let mut buf = Vec::new();
// Read alphanumeric ASCII including whitespace until we find a closing curly.
loop {
match chars.next() {
None => bail!("unclosed escape literal"),
Some('}') => break,
Some(c) if c.is_ascii() => buf.push(c),
Some(c) => bail!("Invalid ado.net token `{}`", c),
}
}
TokenKind::Escaped(buf)
}
';' => TokenKind::Semi,
'=' => TokenKind::Eq,
'\n' => TokenKind::Newline,
' ' => TokenKind::Whitespace,
char if char.is_ascii() => TokenKind::Atom(char),
char => bail!("Invalid character found: {}", char),
};
tokens.push(Token::new(kind, loc));
input = chars.as_str();
let consumed = old_input.len() - input.len();
loc.advance(&old_input[..consumed]);
}
tokens.reverse();
Ok(Self { tokens })
}
/// Get the next token from the queue.
#[must_use]
pub(crate) fn next(&mut self) -> Token {
self.tokens.pop().unwrap_or(Token {
kind: TokenKind::Eof,
loc: Location::default(),
})
}
/// Peek at the next token in the queue.
#[must_use]
pub(crate) fn peek(&mut self) -> Token {
self.tokens.last().cloned().unwrap_or(Token {
kind: TokenKind::Eof,
loc: Location::default(),
})
}
}
/// Look at the next char in the iterator.
fn lookahead(iter: &std::str::Chars<'_>) -> Option<char> {
let s = iter.as_str();
s.chars().next()
}
/// Track the location of the Token inside the string.
#[derive(Copy, Clone, Default, Debug)]
pub(crate) struct Location {
pub(crate) column: usize,
}
impl Location {
fn advance(&mut self, text: &str) {
self.column += text.chars().count();
}
}
#[cfg(test)]
mod test {
use super::AdoNetString;
fn assert_kv(ado: &AdoNetString, key: &str, value: &str) {
assert_eq!(ado.get(&key.to_lowercase()), Some(&value.to_owned()));
}
// Source: https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-string-syntax#windows-authentication-with-sqlclient
// https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-string-syntax#windows-authentication-with-sqlclient
#[test]
fn windows_auth_with_sql_client() -> crate::Result<()> {
let input = "Persist Security Info=False;Integrated Security=true;\nInitial Catalog=AdventureWorks;Server=MSSQL1";
let ado: AdoNetString = input.parse()?;
assert_kv(&ado, "Persist Security Info", "False");
assert_kv(&ado, "Integrated Security", "true");
assert_kv(&ado, "Server", "MSSQL1");
assert_kv(&ado, "Initial Catalog", "AdventureWorks");
Ok(())
}
// https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-string-syntax#sql-server-authentication-with-sqlclient
#[test]
fn sql_server_auth_with_sql_client() -> crate::Result<()> {
let input = "Persist Security Info=False;User ID=*****;Password=*****;Initial Catalog=AdventureWorks;Server=MySqlServer";
let ado: AdoNetString = input.parse()?;
assert_kv(&ado, "Persist Security Info", "False");
assert_kv(&ado, "User ID", "*****");
assert_kv(&ado, "Password", "*****");
assert_kv(&ado, "Initial Catalog", "AdventureWorks");
assert_kv(&ado, "Server", "MySqlServer");
Ok(())
}
// https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-string-syntax#connect-to-a-named-instance-of-sql-server
#[test]
fn connect_to_named_sql_server_instance() -> crate::Result<()> {
let input = r#"Data Source=MySqlServer\MSSQL1;"#;
let ado: AdoNetString = input.parse()?;
assert_kv(&ado, "Data Source", r#"MySqlServer\MSSQL1"#);
Ok(())
}
// https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-string-syntax#oledb-connection-string-syntax
#[test]
fn oledb_connection_string_syntax() -> crate::Result<()> {
let input = r#"Provider=Microsoft.Jet.OLEDB.4.0; Data Source=d:\Northwind.mdb;User ID=Admin;Password=;"#;
let ado: AdoNetString = input.parse()?;
assert_kv(&ado, "Provider", r#"Microsoft.Jet.OLEDB.4.0"#);
assert_kv(&ado, "Data Source", r#"d:\Northwind.mdb"#);
assert_kv(&ado, "User ID", r#"Admin"#);
assert_kv(&ado, "Password", r#""#);
let input = r#"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=d:\Northwind.mdb;Jet OLEDB:System Database=d:\NorthwindSystem.mdw;User ID=*****;Password=*****;"#;
let ado: AdoNetString = input.parse()?;
assert_kv(&ado, "Provider", r#"Microsoft.Jet.OLEDB.4.0"#);
assert_kv(&ado, "Data Source", r#"d:\Northwind.mdb"#);
assert_kv(
&ado,
"Jet OLEDB:System Database",
r#"d:\NorthwindSystem.mdw"#,
);
assert_kv(&ado, "User ID", r#"*****"#);
assert_kv(&ado, "Password", r#"*****"#);
Ok(())
}
// https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-string-syntax#using-datadirectory-to-connect-to-accessjet
#[test]
fn connect_to_access_jet() -> crate::Result<()> {
let input = r#"Provider=Microsoft.Jet.OLEDB.4.0;
Data Source=|DataDirectory|\Northwind.mdb;
Jet OLEDB:System Database=|DataDirectory|\System.mdw;"#;
let ado: AdoNetString = input.parse()?;
assert_kv(&ado, "Data Source", r#"|DataDirectory|\Northwind.mdb"#);
assert_kv(&ado, "Provider", r#"Microsoft.Jet.OLEDB.4.0"#);
assert_kv(
&ado,
"Jet OLEDB:System Database",
r#"|DataDirectory|\System.mdw"#,
);
Ok(())
}
// NOTE(yosh): we do not support Excel connection strings yet because the
// double quote escaping is a small nightmare to parse.
// // https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-string-syntax#connecting-to-excel
// #[test]
// fn connect_to_excel() -> crate::Result<()> {
// let input = r#"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=D:\MyExcel.xls;Extended Properties=""Excel 8.0;HDR=Yes;IMEX=1"""#;
// let ado: AdoNetString = input.parse()?;
// assert_kv(&ado, "Provider", r#"Microsoft.Jet.OLEDB.4.0"#);
// assert_kv(&ado, "Data Source", r#"D:\MyExcel.xls"#);
// assert_kv(
// &ado,
// "Extended Properties",
// r#"""Excel 8.0;HDR=Yes;IMEX=1"""#,
// );
// Ok(())
// }
// https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-string-syntax#data-shape-provider-connection-string-syntax
#[test]
fn data_shape_provider() -> crate::Result<()> {
let input = r#"Provider=MSDataShape;Data Provider=SQLOLEDB;Data Source=(local);Initial Catalog=pubs;Integrated Security=SSPI;"#;
let ado: AdoNetString = input.parse()?;
assert_kv(&ado, "Provider", r#"MSDataShape"#);
assert_kv(&ado, "Data Provider", r#"SQLOLEDB"#);
assert_kv(&ado, "Data Source", r#"(local)"#);
assert_kv(&ado, "Initial Catalog", r#"pubs"#);
assert_kv(&ado, "Integrated Security", r#"SSPI"#);
Ok(())
}
// NOTE(yosh): we do not support ODBC connection strings because the first part of the
// https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-string-syntax#odbc-connection-strings
#[test]
fn odbc_connection_strings() -> crate::Result<()> {
let input = r#"Driver={Microsoft Text Driver (*.txt; *.csv)};DBQ=d:\bin"#;
let ado: AdoNetString = input.parse()?;
assert_kv(&ado, "Driver", r#"Microsoft Text Driver (*.txt; *.csv)"#);
assert_kv(&ado, "DBQ", r#"d:\bin"#);
Ok(())
}
// https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-string-syntax#oracle-connection-strings
#[test]
fn oracle_connection_strings() -> crate::Result<()> {
let input = "Data Source=Oracle9i;User ID=*****;Password=*****;";
let ado: AdoNetString = input.parse()?;
assert_kv(&ado, "Data Source", "Oracle9i");
assert_kv(&ado, "User ID", "*****");
assert_kv(&ado, "Password", "*****");
Ok(())
}
#[test]
fn display_with_escaping() -> crate::Result<()> {
let input = "key=val{;}ue";
let conn: AdoNetString = input.parse()?;
assert_eq!(format!("{}", conn), input);
Ok(())
}
}