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
use std::{cmp::max, collections::HashMap, sync::Mutex}; use crate::{handles, Connection, Error}; use odbc_sys::{AttrOdbcVersion, FetchOrientation}; use widestring::{U16CStr, U16Str, U16String}; /// An ODBC 3.8 environment. /// /// Associated with an `Environment` is any information that is global in nature, such as: /// /// * The `Environment`'s state /// * The current environment-level diagnostics /// * The handles of connections currently allocated on the environment /// * The current stetting of each environment attribute /// /// Creating the environment is the first applications do, then interacting with an ODBC driver /// manager. There must only be one environment in the entire process. pub struct Environment { environment: handles::Environment, /// ODBC environments use interior mutability to maintain iterator state then iterating over /// driver and / or data source information. The environment is otherwise protected by interior /// synchronization mechanism, yet in order to be able to access to iterate over information /// using a shared reference we need to protect the interior iteraton state with a mutex of its /// own. info_iterator_state: Mutex<()>, } impl Environment { /// Entry point into this API. Allocates a new ODBC Environment and declares to the driver /// manager that the Application wants to use ODBC version 3.8. /// /// # Safety /// /// There may only be one ODBC environment in any process at any time. Take care using this /// function in unit tests, as these run in parallel by default in Rust. Also no library should /// probably wrap the creation of an odbc environment into a safe function call. This is because /// using two of these "safe" libraries at the same time in different parts of your program may /// lead to race condition thus violating Rust's safety guarantees. /// /// Creating one environment in your binary is safe however. pub unsafe fn new() -> Result<Self, Error> { let environment = crate::handles::Environment::new()?; environment.declare_version(AttrOdbcVersion::Odbc3_80)?; Ok(Self { environment, info_iterator_state: Mutex::new(()), }) } /// Allocates a connection handle and establishes connections to a driver and a data source. /// /// * See [Connecting with SQLConnect][1] /// * See [SQLConnectFunction][2] /// /// # Arguments /// /// * `data_source_name` - Data source name. The data might be located on the same computer as /// the program, or on another computer somewhere on a network. /// * `user` - User identifier. /// * `pwd` - Authentication string (typically the password). /// /// # Example /// /// ```no_run /// use odbc_api::Environment; /// /// // I herby solemnly swear that this is the only ODBC environment in the entire process, thus /// // making this call safe. /// let env = unsafe { /// Environment::new()? /// }; /// /// let mut conn = env.connect("YourDatabase", "SA", "<YourStrong@Passw0rd>")?; /// # Ok::<(), odbc_api::Error>(()) /// ``` /// /// [1]: https://docs.microsoft.com/sql/odbc/reference/syntax/sqlconnect-function /// [2]: https://docs.microsoft.com/sql/odbc/reference/syntax/sqlconnect-function pub fn connect( &self, data_source_name: &str, user: &str, pwd: &str, ) -> Result<Connection<'_>, Error> { let data_source_name = U16String::from_str(data_source_name); let user = U16String::from_str(user); let pwd = U16String::from_str(pwd); self.connect_utf16(&data_source_name, &user, &pwd) } /// Allocates a connection handle and establishes connections to a driver and a data source. /// /// * See [Connecting with SQLConnect][1] /// * See [SQLConnectFunction][2] /// /// # Arguments /// /// * `data_source_name` - Data source name. The data might be located on the same computer as /// the program, or on another computer somewhere on a network. /// * `user` - User identifier. /// * `pwd` - Authentication string (typically the password). /// /// [1]: https://docs.microsoft.com/sql/odbc/reference/syntax/sqlconnect-function /// [2]: https://docs.microsoft.com/sql/odbc/reference/syntax/sqlconnect-function pub fn connect_utf16( &self, data_source_name: &U16Str, user: &U16Str, pwd: &U16Str, ) -> Result<Connection<'_>, Error> { let mut connection = self.environment.allocate_connection()?; connection.connect(data_source_name, user, pwd)?; Ok(Connection::new(connection)) } /// Allocates a connection handle and establishes connections to a driver and a data source. /// /// An alternative to `connect`. It supports data sources that require more connection /// information than the three arguments in `connect` and data sources that are not defined in /// the system information. /// /// To find out your connection string try: <https://www.connectionstrings.com/> /// /// # Example /// /// ```no_run /// use odbc_api::Environment; /// /// // I herby solemnly swear that this is the only ODBC environment in the entire process, thus /// // making this call safe. /// let env = unsafe { /// Environment::new()? /// }; /// /// let connection_string = " /// Driver={ODBC Driver 17 for SQL Server};\ /// Server=localhost;\ /// UID=SA;\ /// PWD=<YourStrong@Passw0rd>;\ /// "; /// /// let mut conn = env.connect_with_connection_string(connection_string)?; /// # Ok::<(), odbc_api::Error>(()) /// ``` pub fn connect_with_connection_string( &self, connection_string: &str, ) -> Result<Connection<'_>, Error> { let connection_string = U16String::from_str(connection_string); self.connect_with_connection_string_utf16(&connection_string) } /// Allocates a connection handle and establishes connections to a driver and a data source. /// /// An alternative to `connect`. It supports data sources that require more connection /// information than the three arguments in `connect` and data sources that are not defined in /// the system information. /// /// To find out your connection string try: <https://www.connectionstrings.com/> pub fn connect_with_connection_string_utf16( &self, connection_string: &U16Str, ) -> Result<Connection<'_>, Error> { let mut connection = self.environment.allocate_connection()?; connection.connect_with_connection_string(connection_string)?; Ok(Connection::new(connection)) } /// Get information about available drivers. Only 32 or 64 Bit drivers will be listed, depending /// on wether you are building a 32 Bit or 64 Bit application. /// /// # Example /// /// ```no_run /// use odbc_api::Environment; /// /// let env = unsafe { Environment::new () }?; /// for driver_info in env.drivers()? { /// println!("{:#?}", driver_info); /// } /// /// # Ok::<_, odbc_api::Error>(()) /// ``` pub fn drivers(&self) -> Result<Vec<DriverInfo>, Error> { let mut driver_info = Vec::new(); // Since we have exclusive ownership of the environment handle and we take the lock, we can // guarantee that this method is currently the only one changing the state of the internal // iterators of the environment. let _lock = self.info_iterator_state.lock().unwrap(); unsafe { // Find required buffer size to avoid truncation. let (mut desc_len, mut attr_len) = if let Some(v) = self .environment // Start with first so we are independent of state .drivers_buffer_len(FetchOrientation::First)? { v } else { // No drivers present return Ok(Vec::new()); }; // If there are let's loop over the rest while let Some((candidate_desc_len, candidate_attr_len)) = self .environment .drivers_buffer_len(FetchOrientation::Next)? { desc_len = max(candidate_desc_len, desc_len); attr_len = max(candidate_attr_len, attr_len); } // Allocate +1 character extra for terminating zero let mut desc_buf = vec![0; desc_len as usize + 1]; let mut attr_buf = vec![0; attr_len as usize + 1]; while self.environment.drivers_buffer_fill( FetchOrientation::Next, &mut desc_buf, &mut attr_buf, )? { let description = U16CStr::from_slice_with_nul(&desc_buf).unwrap(); let attributes = U16CStr::from_slice_with_nul(&attr_buf).unwrap(); let description = description.to_string().unwrap(); let attributes = attributes.to_string().unwrap(); let attributes = attributes_iter(&attributes).collect(); driver_info.push(DriverInfo { description, attributes, }); } } Ok(driver_info) } /// User and system data sources /// /// # Example /// /// ```no_run /// use odbc_api::Environment; /// /// let env = unsafe { Environment::new () }?; /// for data_source in env.data_sources()? { /// println!("{:#?}", data_source); /// } /// /// # Ok::<_, odbc_api::Error>(()) /// ``` pub fn data_sources(&self) -> Result<Vec<DataSourceInfo>, Error> { self.data_sources_impl(FetchOrientation::First) } /// Only system data sources /// /// # Example /// /// ```no_run /// use odbc_api::Environment; /// /// let env = unsafe { Environment::new () }?; /// for data_source in env.system_data_sources()? { /// println!("{:#?}", data_source); /// } /// /// # Ok::<_, odbc_api::Error>(()) /// ``` pub fn system_data_sources(&self) -> Result<Vec<DataSourceInfo>, Error> { self.data_sources_impl(FetchOrientation::FirstSystem) } /// Only user data sources /// /// # Example /// /// ```no_run /// use odbc_api::Environment; /// /// let mut env = unsafe { Environment::new () }?; /// for data_source in env.user_data_sources()? { /// println!("{:#?}", data_source); /// } /// /// # Ok::<_, odbc_api::Error>(()) /// ``` pub fn user_data_sources(&self) -> Result<Vec<DataSourceInfo>, Error> { self.data_sources_impl(FetchOrientation::FirstUser) } fn data_sources_impl(&self, direction: FetchOrientation) -> Result<Vec<DataSourceInfo>, Error> { let mut data_source_info = Vec::new(); // Since we have exclusive ownership of the environment handle and we take the lock, we can // guarantee that this method is currently the only one changing the state of the internal // iterators of the environment. let _lock = self.info_iterator_state.lock().unwrap(); unsafe { // Find required buffer size to avoid truncation. let (mut server_name_len, mut driver_len) = if let Some(v) = self.environment.data_source_buffer_len(direction)? { v } else { // No drivers present return Ok(Vec::new()); }; // If there are let's loop over the rest while let Some((candidate_name_len, candidate_decs_len)) = self .environment .drivers_buffer_len(FetchOrientation::Next)? { server_name_len = max(candidate_name_len, server_name_len); driver_len = max(candidate_decs_len, driver_len); } // Allocate +1 character extra for terminating zero let mut server_name_buf = vec![0; server_name_len as usize + 1]; let mut driver_buf = vec![0; driver_len as usize + 1]; let mut not_empty = self.environment.data_source_buffer_fill( direction, &mut server_name_buf, &mut driver_buf, )?; while not_empty { let server_name = U16CStr::from_slice_with_nul(&server_name_buf).unwrap(); let driver = U16CStr::from_slice_with_nul(&driver_buf).unwrap(); let server_name = server_name.to_string().unwrap(); let driver = driver.to_string().unwrap(); data_source_info.push(DataSourceInfo { server_name, driver, }); not_empty = self.environment.data_source_buffer_fill( FetchOrientation::Next, &mut server_name_buf, &mut driver_buf, )?; } } Ok(data_source_info) } } /// Struct holding information available on a driver. Can be obtained via [`Environment::drivers`]. #[derive(Clone, Debug, Eq, PartialEq)] pub struct DriverInfo { /// Name of the ODBC driver pub description: String, /// Attributes values of the driver by key pub attributes: HashMap<String, String>, } /// Holds name and description of a datasource /// /// Can be obtained via [`Environment::data_sources`] #[derive(Clone, Debug, Eq, PartialEq)] pub struct DataSourceInfo { /// Name of the data source pub server_name: String, /// Description of the data source pub driver: String, } /// Called by drivers to pares list of attributes /// /// Key value pairs are separated by `\0`. Key and value are separated by `=` fn attributes_iter(attributes: &str) -> impl Iterator<Item = (String, String)> + '_ { attributes .split('\0') .take_while(|kv_str| *kv_str != String::new()) .map(|kv_str| { let mut iter = kv_str.split('='); let key = iter.next().unwrap(); let value = iter.next().unwrap(); (key.to_string(), value.to_string()) }) } #[cfg(test)] mod test { use super::*; #[test] fn parse_attributes() { let buffer = "APILevel=2\0ConnectFunctions=YYY\0CPTimeout=60\0DriverODBCVer=03.\ 50\0FileUsage=0\0SQLLevel=1\0UsageCount=1\0\0"; let attributes: HashMap<_, _> = attributes_iter(buffer).collect(); assert_eq!(attributes["APILevel"], "2"); assert_eq!(attributes["ConnectFunctions"], "YYY"); assert_eq!(attributes["CPTimeout"], "60"); assert_eq!(attributes["DriverODBCVer"], "03.50"); assert_eq!(attributes["FileUsage"], "0"); assert_eq!(attributes["SQLLevel"], "1"); assert_eq!(attributes["UsageCount"], "1"); } }