diff --git a/COPYING b/COPYING new file mode 100644 --- /dev/null +++ b/COPYING @@ -0,0 +1,510 @@ + + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations +below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it +becomes a de-facto standard. To achieve this, non-free programs must +be allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control +compilation and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at least + three years, to give the same user the materials specified in + Subsection 6a, above, for a charge no more than the cost of + performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply, and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License +may add an explicit geographical distribution limitation excluding those +countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms +of the ordinary General Public License). + + To apply these terms, attach the following notices to the library. +It is safest to attach them to the start of each source file to most +effectively convey the exclusion of warranty; and each file should +have at least the "copyright" line and a pointer to where the full +notice is found. + + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or +your school, if any, to sign a "copyright disclaimer" for the library, +if necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James + Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + diff --git a/Database/HDBC/MySQL.hs b/Database/HDBC/MySQL.hs new file mode 100644 --- /dev/null +++ b/Database/HDBC/MySQL.hs @@ -0,0 +1,42 @@ +{- | + +This module provides a MySQL driver for the HDBC database interface. +To use it, invoke the 'connectMySQL' method to create an +@Database.HDBC.IConnection@ that you can use to interact with a MySQL +database. Use the 'defaultMySQLConnectInfo', overriding the default +values as necessary. + +> import Control.Monad +> import Database.HDBC +> import Database.HDBC.MySQL +> main = do conn <- connectMySQL defaultMySQLConnectInfo { +> mysqlHost = "db1.example.com", +> mysqlUser = "scott", +> mysqlPassword = "tiger" +> } +> +> rows <- quickQuery' conn "SELECT 1 + 1" [] +> forM_ rows $ \row -> putStrLn $ show row + +There are some important caveats to note about this driver. + +The first relates to transaction support. The MySQL server supports a +variety of backend \"engines\", only some of which support +transactional access (e.g., InnoDB). This driver will report that the +database supports transactions. Should you decide to make use of the +transactional support in the HDBC API, +/it is up to you to make sure that you use a MySQL engine that supports transactions/. + +The next relates to dates and times. MySQL does not store time zone +information in @DATETIME@ or @TIMESTAMP@ columns: instead, it assumes +that all dates are stored in the \"server's time zone\". At some +point in the future, this driver may query for the server's time zone +and apply appropriate time zone conversion to these datatypes. For +now, it simply treats all times as UTC; i.e., it assumes the server's +time zone is UTC. + +-} +module Database.HDBC.MySQL + (connectMySQL, MySQLConnectInfo(..), defaultMySQLConnectInfo) +where +import Database.HDBC.MySQL.Connection diff --git a/Database/HDBC/MySQL/Connection.hsc b/Database/HDBC/MySQL/Connection.hsc new file mode 100644 --- /dev/null +++ b/Database/HDBC/MySQL/Connection.hsc @@ -0,0 +1,782 @@ +-- -*- mode: haskell; -*- +{-# OPTIONS -fglasgow-exts #-} + +module Database.HDBC.MySQL.Connection + (connectMySQL, MySQLConnectInfo(..), defaultMySQLConnectInfo) +where + +import Control.Exception +import Control.Monad +import Foreign +import Foreign.C +import qualified Data.ByteString as B +import Data.IORef +import Data.List (isPrefixOf) +import Data.Time +import Data.Time.Clock.POSIX + +import qualified Database.HDBC.Types as Types +import Database.HDBC.ColTypes as ColTypes + +#include + +{- | Connection information to use with connectMySQL. + + You must either supply a host and port, or the name of a Unix + socket. + +-} +data MySQLConnectInfo = MySQLConnectInfo + { -- | e.g., @\"db1.example.com\"@ + mysqlHost :: String + -- | e.g., @\"scott\"@ + , mysqlUser :: String + -- | e.g., @\"tiger\"@ + , mysqlPassword :: String + -- | the \"default\" database name; e.g., @\"emp\"@ + , mysqlDatabase :: String + -- | e.g., @3306@ + , mysqlPort :: Int + -- | e.g., @\"\/var\/lib\/mysql.sock\"@ + , mysqlUnixSocket :: String + } + +{- | Typical connection information, meant to be overridden partially, + for example: + + > connectMySQL defaultMySQLConnectInfo { mysqlHost = "db1" } + + In particular, the default values are @\"127.0.0.1\"@ as the + host, @3306@ as the port, @\"root\"@ as the user, no password, + and @\"test\"@ as the default database. + +-} +defaultMySQLConnectInfo :: MySQLConnectInfo +defaultMySQLConnectInfo = MySQLConnectInfo "127.0.0.1" "root" "" "test" 3306 "" + +data Connection = Connection + { disconnect :: IO () + , commit :: IO () + , rollback :: IO () + , run :: String -> [Types.SqlValue] -> IO Integer + , prepare :: String -> IO Types.Statement + , clone :: IO Connection + , hdbcDriverName :: String + , hdbcClientVer :: String + , proxiedClientName :: String + , proxiedClientVer :: String + , dbServerVer :: String + , dbTransactionSupport :: Bool + , getTables :: IO [String] + , describeTable :: String -> IO [(String, ColTypes.SqlColDesc)] + } + +instance Types.IConnection Connection where + disconnect = disconnect + commit = commit + rollback = rollback + run = run + prepare = prepare + clone = clone + hdbcDriverName = hdbcDriverName + hdbcClientVer = hdbcClientVer + proxiedClientName = proxiedClientName + proxiedClientVer = proxiedClientVer + dbServerVer = dbServerVer + dbTransactionSupport = dbTransactionSupport + getTables = getTables + describeTable = describeTable + +-- The "real" connection to the MySQL server. Wraps mysql.h's MYSQL +-- struct. We don't ever need to look inside it. +data MYSQL + +{- | Connects to a MySQL database using the specified + connection information. -} +connectMySQL :: MySQLConnectInfo -> IO Connection +connectMySQL info = do + mysql_ <- mysql_init nullPtr + when (mysql_ == nullPtr) (error "mysql_init failed") + withCString (mysqlHost info) $ \host_ -> + withCString (mysqlUser info) $ \user_ -> + withCString (mysqlPassword info) $ \passwd_ -> + withCString (mysqlDatabase info) $ \db_ -> + withCString (mysqlUnixSocket info) $ \unixSocket_ -> + do rv <- mysql_real_connect mysql_ host_ user_ passwd_ db_ + (fromIntegral $ mysqlPort info) + unixSocket_ + when (rv == nullPtr) (connectionError mysql_) + wrap mysql_ + where + -- Returns the HDBC wrapper for the native MySQL connection + -- object. + wrap :: Ptr MYSQL -> IO Connection + wrap mysql_ = do + clientver <- peekCString =<< mysql_get_client_info + serverver <- peekCString =<< mysql_get_server_info mysql_ + protover <- mysql_get_proto_info mysql_ + + -- HDBC assumes that there is no such thing as auto-commit. + -- So we'll turn it off here and start our first transaction. + mysql_autocommit mysql_ 0 + + mysql__ <- newForeignPtr mysql_close mysql_ + doStartTransaction mysql__ + + return $ Connection + { disconnect = finalizeForeignPtr mysql__ + , commit = doCommit mysql__ >> doStartTransaction mysql__ + , rollback = doRollback mysql__ >> doStartTransaction mysql__ + , run = doRun mysql__ + , prepare = newStatement mysql__ + , clone = connectMySQL info + , hdbcDriverName = "mysql" + , hdbcClientVer = clientver + , proxiedClientName = "mysql" + , proxiedClientVer = show protover + , dbServerVer = serverver + , dbTransactionSupport = True + , getTables = doGetTables mysql__ + , describeTable = doDescribeTable mysql__ + } + +-- A MySQL statement: wraps mysql.h's MYSQL_STMT struct. +data MYSQL_STMT + +-- A MySQL result: wraps mysql.h's MYSQL_RES struct. +data MYSQL_RES + +-- A MySQL field: wraps mysql.h's MYSQL_FIELD struct. We do actually +-- have to spelunk this structure, so it's a Storable instance. +data MYSQL_FIELD = MYSQL_FIELD + { fieldName :: String + , fieldLength :: CULong + , fieldMaxLength :: CULong + , fieldType :: CInt + , fieldDecimals :: CUInt + , fieldFlags :: CUInt + } + +instance Storable MYSQL_FIELD where + sizeOf _ = #const sizeof(MYSQL_FIELD) + alignment _ = alignment (undefined :: CInt) + + peek p = do + fname <- peekCString =<< (#peek MYSQL_FIELD, name) p + flength <- (#peek MYSQL_FIELD, length) p + fmaxlen <- (#peek MYSQL_FIELD, max_length) p + ftype <- (#peek MYSQL_FIELD, type) p + fdec <- (#peek MYSQL_FIELD, decimals) p + fflags <- (#peek MYSQL_FIELD, flags) p + return $ MYSQL_FIELD + { fieldName = fname + , fieldLength = flength + , fieldMaxLength = fmaxlen + , fieldType = ftype + , fieldDecimals = fdec + , fieldFlags = fflags + } + + poke _ _ = error "MYSQL_FIELD: poke" + +-- A MySQL binding to a query parameter or result. This wraps +-- mysql.h's MYSQL_BIND struct, and it's also Storable -- in this +-- case, so that we can create them. +data MYSQL_BIND = MYSQL_BIND + { bindLength :: Ptr CULong + , bindIsNull :: Ptr CChar + , bindBuffer :: Ptr () + , bindError :: Ptr CChar + , bindBufferType :: CInt + , bindBufferLength :: CULong + } + +instance Storable MYSQL_BIND where + sizeOf _ = #const sizeof(MYSQL_BIND) + alignment _ = alignment (undefined :: CInt) + + peek _ = error "MYSQL_BIND: peek" + + poke p (MYSQL_BIND len_ isNull_ buf_ err_ buftyp buflen) = do + memset (castPtr p) 0 #{const sizeof(MYSQL_BIND)} + (#poke MYSQL_BIND, length) p len_ + (#poke MYSQL_BIND, is_null) p isNull_ + (#poke MYSQL_BIND, buffer) p buf_ + (#poke MYSQL_BIND, error) p err_ + (#poke MYSQL_BIND, buffer_type) p buftyp + (#poke MYSQL_BIND, buffer_length) p buflen + +data MYSQL_TIME = MYSQL_TIME + { timeYear :: CInt + , timeMonth :: CInt + , timeDay :: CInt + , timeHour :: CInt + , timeMinute :: CInt + , timeSecond :: CInt + } + +instance Storable MYSQL_TIME where + sizeOf _ = #const sizeof(MYSQL_TIME) + alignment _ = alignment (undefined :: CInt) + + peek p = do + year <- (#peek MYSQL_TIME, year) p + month <- (#peek MYSQL_TIME, month) p + day <- (#peek MYSQL_TIME, day) p + hour <- (#peek MYSQL_TIME, hour) p + minute <- (#peek MYSQL_TIME, minute) p + second <- (#peek MYSQL_TIME, second) p + return (MYSQL_TIME year month day hour minute second) + + poke p t = do + memset (castPtr p) 0 #{const sizeof(MYSQL_TIME)} + (#poke MYSQL_TIME, year) p (timeYear t) + (#poke MYSQL_TIME, month) p (timeMonth t) + (#poke MYSQL_TIME, day) p (timeDay t) + (#poke MYSQL_TIME, hour) p (timeHour t) + (#poke MYSQL_TIME, minute) p (timeMinute t) + (#poke MYSQL_TIME, second) p (timeSecond t) + +-- Prepares a new Statement for execution. +newStatement :: ForeignPtr MYSQL -> String -> IO Types.Statement +newStatement mysql__ query = withForeignPtr mysql__ $ \mysql_ -> do + stmt_ <- mysql_stmt_init mysql_ + when (stmt_ == nullPtr) (connectionError mysql_) + + -- If an error occurs below, we'll lose the reference to the foreign + -- pointer and run the finalizer. + stmt__ <- newForeignPtr mysql_stmt_close stmt_ + + withCStringLen query $ \(query_, len) -> do + rv <- mysql_stmt_prepare stmt_ query_ (fromIntegral len) + when (rv /= 0) (statementError stmt_) + + -- Collect the result fields of the statement; this will simply be + -- the empty list if we're doing something that doesn't generate + -- results. + fields <- fieldsOf stmt_ + + -- Create MYSQL_BIND structures for each field and point the the + -- statement at those buffers. Again, if there are no fields, + -- this'll be a no-op. + results <- mapM resultOfField fields + when (not $ null results) + (withArray results $ \bind_ -> do + rv' <- mysql_stmt_bind_result stmt_ bind_ + when (rv' /= 0) (statementError stmt_)) + + -- This is mildly insane. Create an IORef where we can store the + -- finalizer, so we can later free the finalizer. + gptr <- newIORef nullFunPtr + g <- makeFinalizer $ freeBinds results gptr + writeIORef gptr g + addForeignPtrFinalizer g stmt__ + + -- We pass the connection ForeignPtr down to execute and fetchRow as + -- a silly way to keep a reference to it alive so long as the + -- statement is around. + return $ Types.Statement + { Types.execute = execute mysql__ stmt__ + , Types.executeMany = mapM_ $ execute mysql__ stmt__ + , Types.finish = finalizeForeignPtr stmt__ + , Types.fetchRow = fetchRow mysql__ stmt__ results + , Types.originalQuery = query + , Types.getColumnNames = return $ map fieldName fields + , Types.describeResult = return $ map sqlColDescOf fields + } + +type Finalizer a = Ptr a -> IO () +foreign import ccall "wrapper" makeFinalizer + :: Finalizer a -> IO (FunPtr (Finalizer a)) + +-- Release the storage allocated for each bind. +freeBinds :: [MYSQL_BIND] -> IORef (FunPtr (Finalizer a)) -> Ptr MYSQL_STMT -> IO () +freeBinds binds selfPtrRef _ = do + readIORef selfPtrRef >>= freeHaskellFunPtr + mapM_ freeOneBind binds + where freeOneBind bind = do + free $ bindLength bind + free $ bindIsNull bind + free $ bindBuffer bind + free $ bindError bind + +-- Returns the list of fields from a prepared statement. +fieldsOf :: Ptr MYSQL_STMT -> IO [MYSQL_FIELD] +fieldsOf stmt_ = bracket acquire release fieldsOf' + where acquire = mysql_stmt_result_metadata stmt_ + release res_ | res_ == nullPtr = return () + | otherwise = mysql_free_result res_ + fieldsOf' res_ | res_ == nullPtr = return [] + | otherwise = fieldsOfResult res_ + +-- Builds the list of fields from the result set metadata: this is +-- just a helper function for fieldOf, above. +fieldsOfResult :: Ptr MYSQL_RES -> IO [MYSQL_FIELD] +fieldsOfResult res_ = do + field_ <- mysql_fetch_field res_ + if (field_ == nullPtr) + then return [] + else liftM2 (:) (peek field_) (fieldsOfResult res_) + +-- Executes a statement with the specified binding parameters. +execute :: ForeignPtr MYSQL -> ForeignPtr MYSQL_STMT -> [Types.SqlValue] -> IO Integer +execute mysql__ stmt__ params = + withForeignPtr mysql__ $ \_ -> + withForeignPtr stmt__ $ \stmt_ -> do + bindParams stmt_ params + rv <- mysql_stmt_execute stmt_ + when (rv /= 0) (statementError stmt_) + nrows <- mysql_stmt_affected_rows stmt_ + + -- mysql_stmt_affected_rows returns -1 when called on a + -- SELECT statement; the HDBC API expects zero to be + -- returned in this case. + return $ fromIntegral (if nrows == (-1 :: CULLong) then 0 else nrows) + +-- Binds placeholder parameters to values. +bindParams :: Ptr MYSQL_STMT -> [Types.SqlValue] -> IO () +bindParams stmt_ params = do + param_count <- mysql_stmt_param_count stmt_ + let nparams = fromIntegral param_count + + -- XXX i'm not sure if it makes more sense to keep this paranoia, or + -- to simply remove it. The code that immediately follows pads + -- extra bind parameters with nulls. + when (nparams /= length params) + (error "the number of parameter placeholders in the prepared SQL is different than the number of parameters provided") + + let params' = take nparams $ params ++ repeat Types.SqlNull + binds <- mapM bindOfSqlValue params' + withArray binds $ \bind_ -> do + rv <- mysql_stmt_bind_param stmt_ bind_ + when (rv /= 0) (statementError stmt_) + +-- Given a SqlValue, return a MYSQL_BIND structure that we can use to +-- pass its value. +bindOfSqlValue :: Types.SqlValue -> IO MYSQL_BIND + +bindOfSqlValue Types.SqlNull = + with (1 :: CChar) $ \isNull_ -> + return $ MYSQL_BIND + { bindLength = nullPtr + , bindIsNull = isNull_ + , bindBuffer = nullPtr + , bindError = nullPtr + , bindBufferType = #{const MYSQL_TYPE_NULL} + , bindBufferLength = 0 + } + +bindOfSqlValue (Types.SqlString s) = + -- XXX this might not handle embedded null characters correctly. + bindOfSqlValue' (length s) (withCString s) #{const MYSQL_TYPE_VAR_STRING} + +bindOfSqlValue (Types.SqlByteString s) = + bindOfSqlValue' (B.length s) (B.useAsCString s) #{const MYSQL_TYPE_VAR_STRING} + +bindOfSqlValue (Types.SqlInteger n) = + bindOfSqlValue' (8::Int) (with (fromIntegral n :: CLLong)) #{const MYSQL_TYPE_LONGLONG} + +bindOfSqlValue (Types.SqlBool b) = + bindOfSqlValue' (1::Int) (with (if b then 1 else 0 :: CChar)) #{const MYSQL_TYPE_TINY} + +bindOfSqlValue (Types.SqlChar c) = + bindOfSqlValue' (1::Int) (with c) #{const MYSQL_TYPE_TINY} + +bindOfSqlValue (Types.SqlDouble d) = + bindOfSqlValue' (8::Int) (with (realToFrac d :: CDouble)) #{const MYSQL_TYPE_DOUBLE} + +bindOfSqlValue (Types.SqlInt32 n) = + bindOfSqlValue' (4::Int) (with n) #{const MYSQL_TYPE_LONG} + +bindOfSqlValue (Types.SqlInt64 n) = + bindOfSqlValue' (8::Int) (with n) #{const MYSQL_TYPE_LONGLONG} + +bindOfSqlValue (Types.SqlRational n) = + bindOfSqlValue' (8::Int) (with (realToFrac n :: CDouble)) #{const MYSQL_TYPE_DOUBLE} + +bindOfSqlValue (Types.SqlWord32 n) = + bindOfSqlValue' (4::Int) (with n) #{const MYSQL_TYPE_LONG} + +bindOfSqlValue (Types.SqlWord64 n) = + bindOfSqlValue' (8::Int) (with n) #{const MYSQL_TYPE_LONGLONG} + +bindOfSqlValue (Types.SqlEpochTime epoch) = + let t = utcToMysqlTime $ posixSecondsToUTCTime (fromIntegral epoch) in + bindOfSqlValue' (#{const sizeof(MYSQL_TIME)}::Int) (with t) #{const MYSQL_TYPE_DATETIME} + where utcToMysqlTime :: UTCTime -> MYSQL_TIME + utcToMysqlTime (UTCTime day difftime) = + let (y, m, d) = toGregorian day + t = floor $ (realToFrac difftime :: Double) + h = t `div` 3600 + mn = t `div` 60 `mod` 60 + s = t `mod` 60 + in MYSQL_TIME (fromIntegral y) (fromIntegral m) (fromIntegral d) h mn s + +bindOfSqlValue (Types.SqlTimeDiff n) = + let h = fromIntegral $ n `div` 3600 + mn = fromIntegral $ n `div` 60 `mod` 60 + s = fromIntegral $ n `mod` 60 + t = MYSQL_TIME 0 0 0 h mn s in + bindOfSqlValue' (#{const sizeof(MYSQL_TIME)}::Int) (with t) #{const MYSQL_TYPE_TIME} + +-- A nasty helper function that cuts down on the boilerplate a bit. +bindOfSqlValue' :: (Integral a, Storable b) => + a -> + ((Ptr b -> IO MYSQL_BIND) -> IO MYSQL_BIND) -> + CInt -> + IO MYSQL_BIND + +bindOfSqlValue' len buf btype = + let buflen = fromIntegral len in + with (0 :: CChar) $ \isNull_ -> + with buflen $ \len_ -> + buf $ \buf_ -> + return $ MYSQL_BIND + { bindLength = len_ + , bindIsNull = isNull_ + , bindBuffer = castPtr buf_ + , bindError = nullPtr + , bindBufferType = btype + , bindBufferLength = buflen + } + +-- Returns an appropriate binding structure for a field. +resultOfField :: MYSQL_FIELD -> IO MYSQL_BIND +resultOfField field = + let ftype = fieldType field + btype = boundType ftype (fieldDecimals field) + size = boundSize btype (fieldLength field) in + do size_ <- new size + isNull_ <- new (0 :: CChar) + error_ <- new (0 :: CChar) + buffer_ <- mallocBytes (fromIntegral size) + return $ MYSQL_BIND { bindLength = size_ + , bindIsNull = isNull_ + , bindBuffer = buffer_ + , bindError = error_ + , bindBufferType = btype + , bindBufferLength = size + } + +-- Returns the appropriate result type for a particular host type. +boundType :: CInt -> CUInt -> CInt +boundType #{const MYSQL_TYPE_STRING} _ = #{const MYSQL_TYPE_VAR_STRING} +boundType #{const MYSQL_TYPE_TINY} _ = #{const MYSQL_TYPE_LONG} +boundType #{const MYSQL_TYPE_SHORT} _ = #{const MYSQL_TYPE_LONG} +boundType #{const MYSQL_TYPE_INT24} _ = #{const MYSQL_TYPE_LONG} +boundType #{const MYSQL_TYPE_YEAR} _ = #{const MYSQL_TYPE_LONG} +boundType #{const MYSQL_TYPE_ENUM} _ = #{const MYSQL_TYPE_LONG} +boundType #{const MYSQL_TYPE_DECIMAL} 0 = #{const MYSQL_TYPE_LONGLONG} +boundType #{const MYSQL_TYPE_DECIMAL} _ = #{const MYSQL_TYPE_DOUBLE} +boundType #{const MYSQL_TYPE_NEWDECIMAL} 0 = #{const MYSQL_TYPE_LONGLONG} +boundType #{const MYSQL_TYPE_NEWDECIMAL} _ = #{const MYSQL_TYPE_DOUBLE} +boundType #{const MYSQL_TYPE_FLOAT} _ = #{const MYSQL_TYPE_DOUBLE} +boundType #{const MYSQL_TYPE_DATE} _ = #{const MYSQL_TYPE_DATETIME} +boundType #{const MYSQL_TYPE_TIMESTAMP} _ = #{const MYSQL_TYPE_DATETIME} +boundType #{const MYSQL_TYPE_NEWDATE} _ = #{const MYSQL_TYPE_DATETIME} +boundType #{const MYSQL_TYPE_BLOB} _ = #{const MYSQL_TYPE_VAR_STRING} +boundType t _ = t + +-- Returns the amount of storage required for a particular result +-- type. +boundSize :: CInt -> CULong -> CULong +boundSize #{const MYSQL_TYPE_LONG} _ = 4 +boundSize #{const MYSQL_TYPE_DOUBLE} _ = 8 +boundSize _ n = n + +-- Fetches a row from an executed statement and converts the cell +-- values into a list of SqlValue types. +fetchRow :: ForeignPtr MYSQL -> ForeignPtr MYSQL_STMT -> [MYSQL_BIND] -> IO (Maybe [Types.SqlValue]) +fetchRow mysql__ stmt__ results = + withForeignPtr mysql__ $ \_ -> + withForeignPtr stmt__ $ \stmt_ -> do + rv <- mysql_stmt_fetch stmt_ + case rv of + 0 -> row + #{const MYSQL_DATA_TRUNCATED} -> row + #{const MYSQL_NO_DATA} -> return Nothing + _ -> statementError stmt_ + where row = mapM cellValue results >>= \cells -> return $ Just cells + +-- Produces a single SqlValue cell value given the binding, handling +-- nulls appropriately. +cellValue :: MYSQL_BIND -> IO Types.SqlValue +cellValue bind = do + isNull <- peek $ bindIsNull bind + if isNull == 0 then cellValue' else return Types.SqlNull + where cellValue' = do + len <- peek $ bindLength bind + let buftype = bindBufferType bind + buf = bindBuffer bind + nonNullCellValue buftype buf len + +-- Produces a single SqlValue from the binding's type and buffer +-- pointer. It assumes that the value is not null. +nonNullCellValue :: CInt -> Ptr () -> CULong -> IO Types.SqlValue + +nonNullCellValue #{const MYSQL_TYPE_LONG} p _ = do + n :: CLong <- peek $ castPtr p + return $ Types.SqlInteger (fromIntegral n) + +nonNullCellValue #{const MYSQL_TYPE_LONGLONG} p _ = do + n :: CLLong <- peek $ castPtr p + return $ Types.SqlInteger (fromIntegral n) + +nonNullCellValue #{const MYSQL_TYPE_DOUBLE} p _ = do + n :: CDouble <- peek $ castPtr p + return $ Types.SqlDouble (realToFrac n) + +nonNullCellValue #{const MYSQL_TYPE_VAR_STRING} p len = + peekCStringLen ((castPtr p), fromIntegral len) >>= return . Types.SqlString + +nonNullCellValue #{const MYSQL_TYPE_DATETIME} p _ = do + t :: MYSQL_TIME <- peek $ castPtr p + let epoch = (floor . toRational . utcTimeToPOSIXSeconds . mysqlTimeToUTC) t + return $ Types.SqlEpochTime epoch + where mysqlTimeToUTC :: MYSQL_TIME -> UTCTime + mysqlTimeToUTC (MYSQL_TIME y m d h mn s) = + -- XXX so, this is fine if the date we're getting back + -- is UTC. If not, well, it's wrong. + let day = fromGregorian (fromIntegral y) (fromIntegral m) (fromIntegral d) + time = s + mn * 60 + h * 3600 + in UTCTime day (secondsToDiffTime $ fromIntegral time) + +nonNullCellValue #{const MYSQL_TYPE_TIME} p _ = do + (MYSQL_TIME _ _ _ h mn s) <- peek $ castPtr p + let secs = 3600 * h + 60 * mn + s + return $ Types.SqlTimeDiff (fromIntegral secs) + +nonNullCellValue t _ _ = return $ Types.SqlString ("unknown type " ++ show t) + +-- Cough up the column metadata for a field that's returned from a +-- query. +sqlColDescOf :: MYSQL_FIELD -> (String, ColTypes.SqlColDesc) +sqlColDescOf f = + let typ = typeIdOf (fieldType f) + sz = Just $ fromIntegral $ fieldLength f + octlen = Just $ fromIntegral $ fieldLength f + digits = Just $ fromIntegral $ fieldDecimals f + nullable = Just $ (fieldFlags f .&. #{const NOT_NULL_FLAG}) == 0 + in (fieldName f, ColTypes.SqlColDesc typ sz octlen digits nullable) + +-- Returns the HDBC column type appropriate for the MySQL column +-- type. (XXX as far as I can tell, I can't tell the difference +-- between a TEXT and a BLOB column, here.) +typeIdOf :: CInt -> ColTypes.SqlTypeId +typeIdOf #{const MYSQL_TYPE_DECIMAL} = ColTypes.SqlDecimalT +typeIdOf #{const MYSQL_TYPE_TINY} = ColTypes.SqlTinyIntT +typeIdOf #{const MYSQL_TYPE_SHORT} = ColTypes.SqlSmallIntT +typeIdOf #{const MYSQL_TYPE_LONG} = ColTypes.SqlIntegerT +typeIdOf #{const MYSQL_TYPE_FLOAT} = ColTypes.SqlFloatT +typeIdOf #{const MYSQL_TYPE_DOUBLE} = ColTypes.SqlDoubleT +typeIdOf #{const MYSQL_TYPE_NULL} = ColTypes.SqlUnknownT "NULL" +typeIdOf #{const MYSQL_TYPE_TIMESTAMP} = ColTypes.SqlTimestampT +typeIdOf #{const MYSQL_TYPE_LONGLONG} = ColTypes.SqlNumericT +typeIdOf #{const MYSQL_TYPE_INT24} = ColTypes.SqlIntegerT +typeIdOf #{const MYSQL_TYPE_DATE} = ColTypes.SqlDateT +typeIdOf #{const MYSQL_TYPE_TIME} = ColTypes.SqlTimeT +typeIdOf #{const MYSQL_TYPE_DATETIME} = ColTypes.SqlTimestampT +typeIdOf #{const MYSQL_TYPE_YEAR} = ColTypes.SqlNumericT +typeIdOf #{const MYSQL_TYPE_NEWDATE} = ColTypes.SqlDateT +typeIdOf #{const MYSQL_TYPE_VARCHAR} = ColTypes.SqlVarCharT +typeIdOf #{const MYSQL_TYPE_BIT} = ColTypes.SqlBitT +typeIdOf #{const MYSQL_TYPE_NEWDECIMAL} = ColTypes.SqlDecimalT +typeIdOf #{const MYSQL_TYPE_ENUM} = ColTypes.SqlUnknownT "ENUM" +typeIdOf #{const MYSQL_TYPE_SET} = ColTypes.SqlUnknownT "SET" +typeIdOf #{const MYSQL_TYPE_TINY_BLOB} = ColTypes.SqlBinaryT +typeIdOf #{const MYSQL_TYPE_MEDIUM_BLOB} = ColTypes.SqlBinaryT +typeIdOf #{const MYSQL_TYPE_LONG_BLOB} = ColTypes.SqlBinaryT +typeIdOf #{const MYSQL_TYPE_BLOB} = ColTypes.SqlBinaryT +typeIdOf #{const MYSQL_TYPE_VAR_STRING} = ColTypes.SqlVarCharT +typeIdOf #{const MYSQL_TYPE_STRING} = ColTypes.SqlCharT +typeIdOf #{const MYSQL_TYPE_GEOMETRY} = ColTypes.SqlUnknownT "GEOMETRY" +typeIdOf n = ColTypes.SqlUnknownT ("unknown type " ++ show n) + +-- Run a query and discard the results, if any. +doRun :: ForeignPtr MYSQL -> String -> [Types.SqlValue] -> IO Integer +doRun mysql__ query params = do + stmt <- newStatement mysql__ query + Types.execute stmt params + +-- Issue a query "old school", without using the prepared statement +-- API. We use this internally to send the transaction-related +-- statements, because -- it turns out -- we have to! +doQuery :: String -> ForeignPtr MYSQL -> IO () +doQuery stmt mysql__ = withForeignPtr mysql__ $ \mysql_ -> do + withCString stmt $ \stmt_ -> do + rv <- mysql_query mysql_ stmt_ + when (rv /= 0) (connectionError mysql_) + +doCommit :: ForeignPtr MYSQL -> IO () +doCommit = doQuery "COMMIT" + +doRollback :: ForeignPtr MYSQL -> IO () +doRollback = doQuery "ROLLBACK" + +doStartTransaction :: ForeignPtr MYSQL -> IO () +doStartTransaction = doQuery "START TRANSACTION" + +-- Retrieve all the tables in the current database by issuing a "SHOW +-- TABLES" statement. +doGetTables :: ForeignPtr MYSQL -> IO [String] +doGetTables mysql__ = do + stmt <- newStatement mysql__ "SHOW TABLES" + Types.execute stmt [] + rows <- unfoldRows stmt + return $ map (fromSql . head) rows + where fromSql :: Types.SqlValue -> String + fromSql (Types.SqlString s) = s + fromSql _ = error "SHOW TABLES returned a table whose name wasn't a string" + +-- Describe a single table in the database by issuing a "DESCRIBE" +-- statement and parsing the results. (XXX this is sloppy right now; +-- ideally you'd come up with exactly the same results as if you did a +-- describeResult on SELECT * FROM table.) +doDescribeTable :: ForeignPtr MYSQL -> String -> IO [(String, ColTypes.SqlColDesc)] +doDescribeTable mysql__ table = do + stmt <- newStatement mysql__ ("DESCRIBE " ++ table) + Types.execute stmt [] + rows <- unfoldRows stmt + return $ map fromRow rows + where fromRow :: [Types.SqlValue] -> (String, ColTypes.SqlColDesc) + fromRow ((Types.SqlString colname) + :(Types.SqlString coltype) + :(Types.SqlString nullAllowed):_) = + let sqlTypeId = typeIdOfString coltype + -- XXX parse the column width and decimals, too! + nullable = Just $ nullAllowed == "YES" + in (colname, ColTypes.SqlColDesc sqlTypeId Nothing Nothing Nothing nullable) + + fromRow _ = throwDyn $ Types.SqlError "" 0 "DESCRIBE failed" + +-- XXX this is likely to be incomplete. +typeIdOfString :: String -> ColTypes.SqlTypeId +typeIdOfString s + | "int" `isPrefixOf` s = ColTypes.SqlIntegerT + | "bigint" `isPrefixOf` s = ColTypes.SqlIntegerT + | "smallint" `isPrefixOf` s = ColTypes.SqlSmallIntT + | "mediumint" `isPrefixOf` s = ColTypes.SqlIntegerT + | "tinyint" `isPrefixOf` s = ColTypes.SqlTinyIntT + | "decimal" `isPrefixOf` s = ColTypes.SqlDecimalT + | "double" `isPrefixOf` s = ColTypes.SqlDoubleT + | "float" `isPrefixOf` s = ColTypes.SqlFloatT + | "char" `isPrefixOf` s = ColTypes.SqlCharT + | "varchar" `isPrefixOf` s = ColTypes.SqlVarCharT + | "text" `isPrefixOf` s = ColTypes.SqlBinaryT + | "timestamp" `isPrefixOf` s = ColTypes.SqlTimestampT + | "datetime" `isPrefixOf` s = ColTypes.SqlTimestampT + | "date" `isPrefixOf` s = ColTypes.SqlDateT + | "time" `isPrefixOf` s = ColTypes.SqlTimeT + | otherwise = ColTypes.SqlUnknownT s + +-- A helper function that turns an executed statement into the +-- resulting rows. +unfoldRows :: Types.Statement -> IO [[Types.SqlValue]] +unfoldRows stmt = do + row <- Types.fetchRow stmt + case row of + Nothing -> return [] + Just (vals) -> do rows <- unfoldRows stmt + return (vals : rows) + +-- Returns the last statement-level error. +statementError :: Ptr MYSQL_STMT -> IO a +statementError stmt_ = do + errno <- mysql_stmt_errno stmt_ + msg <- peekCString =<< mysql_stmt_error stmt_ + throwDyn $ Types.SqlError "" (fromIntegral errno) msg + +-- Returns the last connection-level error. +connectionError :: Ptr MYSQL -> IO a +connectionError mysql_ = do + errno <- mysql_errno mysql_ + msg <- peekCString =<< mysql_error mysql_ + throwDyn $ Types.SqlError "" (fromIntegral errno) msg + +{- ---------------------------------------------------------------------- -} + +-- Here are all the FFI imports. + +foreign import ccall unsafe mysql_get_client_info + :: IO CString + +foreign import ccall unsafe mysql_get_server_info + :: Ptr MYSQL -> IO CString + +foreign import ccall unsafe mysql_get_proto_info + :: Ptr MYSQL -> IO CUInt + +foreign import ccall unsafe mysql_init + :: Ptr MYSQL + -> IO (Ptr MYSQL) + +foreign import ccall unsafe mysql_real_connect + :: Ptr MYSQL -- the context + -> CString -- hostname + -> CString -- username + -> CString -- password + -> CString -- database + -> CInt -- port + -> CString -- unix socket + -> IO (Ptr MYSQL) + +foreign import ccall unsafe "&mysql_close" mysql_close + :: FunPtr (Ptr MYSQL -> IO ()) + +foreign import ccall unsafe mysql_stmt_init + :: Ptr MYSQL -> IO (Ptr MYSQL_STMT) + +foreign import ccall unsafe mysql_stmt_prepare + :: Ptr MYSQL_STMT -> CString -> CInt -> IO CInt + +foreign import ccall unsafe mysql_stmt_result_metadata + :: Ptr MYSQL_STMT -> IO (Ptr MYSQL_RES) + +foreign import ccall unsafe mysql_stmt_bind_param + :: Ptr MYSQL_STMT -> Ptr MYSQL_BIND -> IO CChar + +foreign import ccall unsafe mysql_stmt_bind_result + :: Ptr MYSQL_STMT -> Ptr MYSQL_BIND -> IO CChar + +foreign import ccall unsafe mysql_stmt_param_count + :: Ptr MYSQL_STMT -> IO CULong + +foreign import ccall unsafe mysql_free_result + :: Ptr MYSQL_RES -> IO () + +foreign import ccall unsafe mysql_stmt_execute + :: Ptr MYSQL_STMT -> IO CInt + +foreign import ccall unsafe mysql_stmt_affected_rows + :: Ptr MYSQL_STMT -> IO CULLong + +foreign import ccall unsafe mysql_fetch_field + :: Ptr MYSQL_RES -> IO (Ptr MYSQL_FIELD) + +foreign import ccall unsafe mysql_stmt_fetch + :: Ptr MYSQL_STMT -> IO CInt + +foreign import ccall unsafe "&mysql_stmt_close" mysql_stmt_close + :: FunPtr (Ptr MYSQL_STMT -> IO ()) + +foreign import ccall unsafe mysql_stmt_errno + :: Ptr MYSQL_STMT -> IO CInt + +foreign import ccall unsafe mysql_stmt_error + :: Ptr MYSQL_STMT -> IO CString + +foreign import ccall unsafe mysql_errno + :: Ptr MYSQL -> IO CInt + +foreign import ccall unsafe mysql_error + :: Ptr MYSQL -> IO CString + +foreign import ccall unsafe mysql_autocommit + :: Ptr MYSQL -> CChar -> IO CChar + +foreign import ccall unsafe mysql_query + :: Ptr MYSQL -> CString -> IO CInt + +foreign import ccall unsafe memset + :: Ptr () -> CInt -> CSize -> IO () + diff --git a/HDBC-mysql.cabal b/HDBC-mysql.cabal new file mode 100644 --- /dev/null +++ b/HDBC-mysql.cabal @@ -0,0 +1,18 @@ +Name: HDBC-mysql +Category: Database +Synopsis: MySQL driver for HDBC +Version: 0.1 +Description: This package provides a MySQL driver for HDBC. +Stability: Experimental +Maintainer: Chris Waterson +Author: Chris Waterson +Copyright: Copyright (c) 2009 Chris Waterson +License: LGPL +License-file: COPYING +Homepage: http://www.maubi.net/~waterson/hacks/hdbc-mysql.html +Build-Depends: base >= 3 && < 4, bytestring, time, HDBC >= 1.1.0 +Exposed-modules: Database.HDBC.MySQL +Other-modules: Database.HDBC.MySQL.Connection +ghc-options: -Wall +Build-Type: Custom +Tested-with: GHC diff --git a/Setup.lhs b/Setup.lhs new file mode 100644 --- /dev/null +++ b/Setup.lhs @@ -0,0 +1,61 @@ +#!/usr/bin/env runhaskell + +\begin{code} +import Distribution.Simple +import Distribution.PackageDescription +import Distribution.Version + +import Distribution.Simple.LocalBuildInfo +import Distribution.Simple.Program +import Distribution.Verbosity + +import Data.Char (isSpace) +import Data.List (dropWhile,span) + +import Control.Monad + +main = defaultMainWithHooks simpleUserHooks { + hookedPrograms = [mysqlConfigProgram], + + confHook = \pkg flags -> do + lbi <- confHook simpleUserHooks pkg flags + bi <- mysqlBuildInfo lbi + return lbi { + localPkgDescr = updatePackageDescription + (Just bi, []) (localPkgDescr lbi) + } +} + +mysqlConfigProgram = (simpleProgram "mysql_config") { + programFindLocation = \verbosity -> do + mysql_config <- findProgramOnPath "mysql_config" verbosity + mysql_config5 <- findProgramOnPath "mysql_config5" verbosity + return (mysql_config `mplus` mysql_config5) + } + +mysqlBuildInfo :: LocalBuildInfo -> IO BuildInfo +mysqlBuildInfo lbi = do + (mysqlConfigProg, _) <- requireProgram verbosity + mysqlConfigProgram AnyVersion (withPrograms lbi) + let mysqlConfig = rawSystemProgramStdout verbosity mysqlConfigProg + ws = " \n\r\t" + + includeDirs <- return . map (drop 2) . split ws =<< mysqlConfig ["--include"] + ldOptions <- return . split ws =<< mysqlConfig ["--libs"] + + return emptyBuildInfo { + ldOptions = ldOptions, + includeDirs = includeDirs + } + where + verbosity = normal -- honestly, this is a hack + +split :: Eq a => [a] -> [a] -> [[a]] +split xs cs = split' $ dropWhile (`elem` xs) cs + where split' [] = [] + split' cs0 = + let (run, cs1) = span (`notElem` xs) cs0 + cs2 = dropWhile (`elem` xs) cs1 + in run:(split' cs2) + +\end{code}