mysql_driver.h 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  1. /*
  2. * Copyright (c) 2008, 2020, Oracle and/or its affiliates.
  3. *
  4. * This program is free software; you can redistribute it and/or modify
  5. * it under the terms of the GNU General Public License, version 2.0, as
  6. * published by the Free Software Foundation.
  7. *
  8. * This program is also distributed with certain software (including
  9. * but not limited to OpenSSL) that is licensed under separate terms,
  10. * as designated in a particular file or component or in included license
  11. * documentation. The authors of MySQL hereby grant you an
  12. * additional permission to link the program and your derivative works
  13. * with the separately licensed software that they have included with
  14. * MySQL.
  15. *
  16. * Without limiting anything contained in the foregoing, this file,
  17. * which is part of MySQL Connector/C++, is also subject to the
  18. * Universal FOSS Exception, version 1.0, a copy of which can be found at
  19. * http://oss.oracle.com/licenses/universal-foss-exception.
  20. *
  21. * This program is distributed in the hope that it will be useful, but
  22. * WITHOUT ANY WARRANTY; without even the implied warranty of
  23. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  24. * See the GNU General Public License, version 2.0, for more details.
  25. *
  26. * You should have received a copy of the GNU General Public License
  27. * along with this program; if not, write to the Free Software Foundation, Inc.,
  28. * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  29. */
  30. #ifndef _MYSQL_DRIVER_H_
  31. #define _MYSQL_DRIVER_H_
  32. #include "cppconn/driver.h"
  33. #include <memory>
  34. extern "C"
  35. {
  36. CPPCONN_PUBLIC_FUNC void * sql_mysql_get_driver_instance();
  37. }
  38. namespace sql
  39. {
  40. namespace mysql
  41. {
  42. namespace NativeAPI
  43. {
  44. class NativeDriverWrapper;
  45. }
  46. //class sql::mysql::NativeAPI::NativeDriverWrapper;
  47. class CPPCONN_PUBLIC_FUNC MySQL_Driver : public sql::Driver
  48. {
  49. #ifdef _WIN32
  50. #pragma warning(push)
  51. #pragma warning(disable: 4251)
  52. #endif
  53. std::unique_ptr< ::sql::mysql::NativeAPI::NativeDriverWrapper > proxy;
  54. #ifdef _WIN32
  55. #pragma warning(pop)
  56. #endif
  57. /*
  58. Note: With current implementation `fido_callback` and `fido_callback_store`
  59. are not really used and should be removed after deprecation of Fido
  60. authentication plugin and when ABI can be changed.
  61. */
  62. ::sql::Fido_Callback* fido_callback = nullptr;
  63. ::sql::Fido_Callback fido_callback_store;
  64. /*
  65. Callback function to be called by WebAuthn authentication plugin to notify
  66. the user.
  67. Note: Currently the same callback can be used wih deprecated Fido
  68. authentication plugin.
  69. Note: The `fido_callback` pointer is re-used as a flag to indicate if
  70. the callback was set by a user and its type (WebAuthn vs. Fido).
  71. */
  72. std::function<void(SQLString)> webauthn_callback;
  73. public:
  74. MySQL_Driver();
  75. MySQL_Driver(const ::sql::SQLString & clientLib);
  76. virtual ~MySQL_Driver();
  77. sql::Connection * connect(const sql::SQLString& hostName, const sql::SQLString& userName, const sql::SQLString& password) override;
  78. sql::Connection * connect(sql::ConnectOptionsMap & options) override;
  79. int getMajorVersion() override;
  80. int getMinorVersion() override;
  81. int getPatchVersion() override;
  82. const sql::SQLString & getName() override;
  83. void setCallBack(sql::Fido_Callback &cb) override;
  84. void setCallBack(sql::Fido_Callback &&cb) override;
  85. void setCallBack(sql::WebAuthn_Callback &cb) override;
  86. void setCallBack(sql::WebAuthn_Callback &&cb) override;
  87. void threadInit() override;
  88. void threadEnd() override;
  89. private:
  90. /* Prevent use of these */
  91. MySQL_Driver(const MySQL_Driver &);
  92. void operator=(MySQL_Driver &);
  93. struct WebAuthn_Callback_Setter;
  94. friend WebAuthn_Callback_Setter;
  95. friend MySQL_Connection;
  96. };
  97. /** We do not hide the function if MYSQLCLIENT_STATIC_BINDING(or anything else) not defined
  98. because the counterpart C function is declared in the cppconn and is always visible.
  99. If dynamic loading is not enabled then its result is just like of get_driver_instance()
  100. */
  101. CPPCONN_PUBLIC_FUNC MySQL_Driver * _get_driver_instance_by_name(const char * const clientlib);
  102. inline static MySQL_Driver * get_driver_instance_by_name(const char * const clientlib)
  103. {
  104. check_lib();
  105. return sql::mysql::_get_driver_instance_by_name(clientlib);
  106. }
  107. inline static MySQL_Driver * get_driver_instance()
  108. {
  109. return sql::mysql::get_driver_instance_by_name("");
  110. }
  111. inline static MySQL_Driver *get_mysql_driver_instance() { return get_driver_instance(); }
  112. } /* namespace mysql */
  113. } /* namespace sql */
  114. #endif // _MYSQL_DRIVER_H_
  115. /*
  116. * Local variables:
  117. * tab-width: 4
  118. * c-basic-offset: 4
  119. * End:
  120. * vim600: noet sw=4 ts=4 fdm=marker
  121. * vim<600: noet sw=4 ts=4
  122. */