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
// Copyright 2021 Datafuse Labs.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use std::collections::HashMap;
use crate::myc;
use crate::{StatementData, Value};
/// A `ParamParser` decodes query parameters included in a client's `EXECUTE` command given
/// type information for the expected parameters.
///
/// Users should invoke [`iter`](struct.ParamParser.html#method.iter) method to iterate over the
/// provided parameters.
pub struct ParamParser<'a> {
pub(crate) params: u16,
pub(crate) bytes: &'a [u8],
pub(crate) long_data: &'a HashMap<u16, Vec<u8>>,
pub(crate) bound_types: &'a mut Vec<(myc::constants::ColumnType, bool)>,
}
impl<'a> ParamParser<'a> {
pub(crate) fn new(input: &'a [u8], stmt: &'a mut StatementData) -> Self {
ParamParser {
params: stmt.params,
bytes: input,
long_data: &stmt.long_data,
bound_types: &mut stmt.bound_types,
}
}
}
impl<'a> IntoIterator for ParamParser<'a> {
type IntoIter = Params<'a>;
type Item = ParamValue<'a>;
fn into_iter(self) -> Params<'a> {
Params {
params: self.params,
input: self.bytes,
nullmap: None,
col: 0,
long_data: self.long_data,
bound_types: self.bound_types,
}
}
}
/// An iterator over parameters provided by a client in an `EXECUTE` command.
pub struct Params<'a> {
params: u16,
input: &'a [u8],
nullmap: Option<&'a [u8]>,
col: u16,
long_data: &'a HashMap<u16, Vec<u8>>,
bound_types: &'a mut Vec<(myc::constants::ColumnType, bool)>,
}
/// A single parameter value provided by a client when issuing an `EXECUTE` command.
pub struct ParamValue<'a> {
/// The value provided for this parameter.
pub value: Value<'a>,
/// The column type assigned to this parameter.
pub coltype: myc::constants::ColumnType,
}
impl<'a> Iterator for Params<'a> {
type Item = ParamValue<'a>;
fn next(&mut self) -> Option<Self::Item> {
if self.nullmap.is_none() {
let nullmap_len = (self.params as usize + 7) / 8;
let (nullmap, rest) = self.input.split_at(nullmap_len);
self.nullmap = Some(nullmap);
self.input = rest;
if !rest.is_empty() && rest[0] != 0x00 {
let (typmap, rest) = rest[1..].split_at(2 * self.params as usize);
self.bound_types.clear();
for i in 0..self.params as usize {
self.bound_types.push((
myc::constants::ColumnType::try_from(typmap[2 * i]).unwrap_or_else(|e| {
panic!("bad column type 0x{:x}: {}", typmap[2 * i], e)
}),
(typmap[2 * i + 1] & 128) != 0,
));
}
self.input = rest;
}
}
if self.col >= self.params {
return None;
}
let pt = &self.bound_types[self.col as usize];
// https://web.archive.org/web/20170404144156/https://dev.mysql.com/doc/internals/en/null-bitmap.html
// NULL-bitmap-byte = ((field-pos + offset) / 8)
// NULL-bitmap-bit = ((field-pos + offset) % 8)
if let Some(nullmap) = self.nullmap {
let byte = self.col as usize / 8;
if byte >= nullmap.len() {
return None;
}
if (nullmap[byte] & 1u8 << (self.col % 8)) != 0 {
self.col += 1;
return Some(ParamValue {
value: Value::null(),
coltype: pt.0,
});
}
} else {
unreachable!();
}
let v = if let Some(data) = self.long_data.get(&self.col) {
Value::bytes(&data[..])
} else {
Value::parse_from(&mut self.input, pt.0, pt.1).unwrap()
};
self.col += 1;
Some(ParamValue {
value: v,
coltype: pt.0,
})
}
}