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
//! Sql parameter types and traits
use crate::{error::FbError, ibase, SqlType};
use regex::{Captures, Regex};
use std::collections::HashMap;
pub use SqlType::*;
/// Max length that can be sent without creating a BLOB
pub const MAX_TEXT_LENGTH: usize = 32767;
impl SqlType {
/// Convert the sql value to interbase format
pub fn sql_type_and_subtype(&self) -> (u32, u32) {
match self {
Text(s) => {
if s.len() > MAX_TEXT_LENGTH {
(ibase::SQL_BLOB + 1, 1)
} else {
(ibase::SQL_TEXT + 1, 0)
}
}
Integer(_) => (ibase::SQL_INT64 + 1, 0),
Floating(_) => (ibase::SQL_DOUBLE + 1, 0),
Timestamp(_) => (ibase::SQL_TIMESTAMP + 1, 0),
Null => (ibase::SQL_TEXT + 1, 0),
Binary(_) => (ibase::SQL_BLOB + 1, 0),
Boolean(_) => (ibase::SQL_BOOLEAN + 1, 0),
}
}
}
/// Implemented for types that can be sent as parameters
pub trait IntoParam {
fn into_param(self) -> SqlType;
}
impl IntoParam for Vec<u8> {
fn into_param(self) -> SqlType {
Binary(self)
}
}
impl IntoParam for String {
fn into_param(self) -> SqlType {
Text(self)
}
}
impl IntoParam for i64 {
fn into_param(self) -> SqlType {
Integer(self)
}
}
impl IntoParam for bool {
fn into_param(self) -> SqlType {
Boolean(self)
}
}
/// Implements AsParam for integers
macro_rules! impl_param_int {
( $( $t: ident ),+ ) => {
$(
impl IntoParam for $t {
fn into_param(self) -> SqlType {
(self as i64).into_param()
}
}
)+
};
}
impl_param_int!(i32, u32, i16, u16, i8, u8);
impl IntoParam for f64 {
fn into_param(self) -> SqlType {
Floating(self)
}
}
impl IntoParam for f32 {
fn into_param(self) -> SqlType {
(self as f64).into_param()
}
}
/// Implements `IntoParam` for all nullable variants
impl<T> IntoParam for Option<T>
where
T: IntoParam,
{
fn into_param(self) -> SqlType {
if let Some(v) = self {
v.into_param()
} else {
Null
}
}
}
/// Implements `IntoParam` for all borrowed variants (&str, Cow and etc)
impl<T, B> IntoParam for &B
where
B: ToOwned<Owned = T> + ?Sized,
T: core::borrow::Borrow<B> + IntoParam,
{
fn into_param(self) -> SqlType {
self.to_owned().into_param()
}
}
/// Implement From / Into conversions
impl<T> From<T> for SqlType
where
T: IntoParam,
{
fn from(param: T) -> Self {
param.into_param()
}
}
/// Parameters type
pub enum ParamsType {
/// Positional parameters, using '?'. This is the default option.
///
/// Firebird provides direct support for this kind of parameter, which this crate makes use of.
Positional(Vec<SqlType>),
/// Named parameters, using the common `:`-prefixed `:param` syntax.
///
/// Support for this kind of parameter is provided by this library.
///
/// Currently only a naive regex-based approach is used, to support very basic
/// select, insert, etc statements
///
/// **CAUTION!**
/// Named parameter support is still very preliminary.
/// Use of named parameters may currently give unexpected results. Please test your queries carefully
/// when using this feature.
///
/// In particular, the simple regex-based parser is known to definitely to have trouble with:
/// * occurences of apostrophe (`'`) anywhere except as string literal delimiters (for example, in comments)
/// * statements with closed variable bindings (which uses the `:var` syntax) (for example, in PSQL via `EXECUTE BLOCK` or `EXECUTE PROCEDURE`)
///
///
/// This crate provides a [derive macro](prelude/derive.IntoParams.html) for supplying arguments via the fields of a struct and their labels.
Named(HashMap<String, SqlType>),
}
impl ParamsType {
pub fn named(&self) -> bool {
match self {
ParamsType::Positional(_) => false,
ParamsType::Named(_) => true,
}
}
}
#[allow(clippy::wrong_self_convention)]
/// Types with an associated boolean flag function, `named()` indiciating support for named or positional parameters.
///
///
/// With both named (as a struct field) or positional (as a Vector or tuple element) parameters, `Option<T>`, with `T` an `IntoParam`, may be used to indicate a nullable argument, wherein the `None` variant provides a `null` value.
///
/// This crate provides a [derive macro](prelude/derive.IntoParams.html) for supplying arguments via the fields of a struct and their labels.
pub trait IntoParams {
fn to_params(self) -> ParamsType;
}
impl IntoParams for ParamsType {
fn to_params(self) -> ParamsType {
self
}
}
/// Allow use of a vector instead of tuples, for run-time-determined parameter count, or
/// for when there are too many parameters to use one of the provided tuple implementations
impl IntoParams for Vec<SqlType> {
fn to_params(self) -> ParamsType {
ParamsType::Positional(self)
}
}
/// Represents 0 parameters
impl IntoParams for () {
fn to_params(self) -> ParamsType {
ParamsType::Positional(vec![])
}
}
/// Generates IntoParams implementations for a tuple
macro_rules! impl_into_params {
($([$t: ident, $v: ident]),+) => {
impl<$($t),+> IntoParams for ($($t,)+)
where
$( $t: IntoParam, )+
{
fn to_params(self) -> ParamsType {
let ( $($v,)+ ) = self;
ParamsType::Positional(vec![ $(
$v.into_param(),
)+ ])
}
}
};
}
/// Generates FromRow implementations for various tuples
macro_rules! impls_into_params {
([$t: ident, $v: ident]) => {
impl_into_params!([$t, $v]);
};
([$t: ident, $v: ident], $([$ts: ident, $vs: ident]),+ ) => {
impls_into_params!($([$ts, $vs]),+);
impl_into_params!([$t, $v], $([$ts, $vs]),+);
};
}
impls_into_params!(
[A, a],
[B, b],
[C, c],
[D, d],
[E, e],
[F, f],
[G, g],
[H, h],
[I, i],
[J, j],
[K, k],
[L, l],
[M, m],
[N, n],
[O, o]
);
/// Named params implementation.
///
/// Works on top of firebird positional parameters (`?`)
pub struct NamedParams {
pub sql: String,
params_names: Vec<String>,
}
impl NamedParams {
/// Parse the sql statement and return a
/// structure representing the named parameters found
pub fn parse(raw_sql: &str) -> Result<Self, FbError> {
let rparams = Regex::new(r#"('[^']*')|:\w+"#)
.map_err(|e| FbError::from(format!("Error on start the regex for named params: {}", e)))
.unwrap();
let mut params_names = vec![];
let sql = rparams
.replace_all(raw_sql, |caps: &Captures| match caps.get(1) {
Some(same) => same.as_str().to_string(),
None => "?".to_string(),
})
.to_string();
for params in rparams.captures_iter(raw_sql) {
for param in params
.iter()
.filter_map(|p| p.map(|m| m.as_str()))
.filter(|p| p.starts_with(':'))
{
params_names.push(param.replace(':', ""));
}
}
Ok(NamedParams { sql, params_names })
}
/// Returns the sql as is, disabling named parameter function
pub fn empty(raw_sql: &str) -> Self {
Self {
sql: raw_sql.to_string(),
params_names: Default::default(),
}
}
/// Re-sort/convert the parameters, applying
/// the named params support
pub fn convert<P>(&self, params: P) -> Result<Vec<SqlType>, FbError>
where
P: IntoParams,
{
match params.to_params() {
ParamsType::Named(names) => {
let mut new_params = vec![];
for qname in &self.params_names {
if let Some(param) = names.get(qname) {
new_params.push(param.clone());
} else {
return Err(FbError::from(format!(
"Param :{} not found in the provided struct",
qname
)));
}
}
Ok(new_params)
}
ParamsType::Positional(p) => Ok(p),
}
}
}