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/COPYRIGHT b/COPYRIGHT new file mode 100644 --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,38 @@ +Copyright (C) 2005, 2006 John Goerzen + + 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 + +Please see COPYING for the license. + +------------------------------------------------------------------ + +pgtypes.h comes from the psqlodbc distribution, which bears this +copyright: + + Copyright (C) 1998 Insight Distribution Systems + Copyright (C) 1998 - 2005 The PostgreSQL Global Development Group + + Multibyte support was added by Sankyo Unyu Service, (C) 2001. + + The code contained in this library is based on code written by + Christian Czezatke and Dan McGuirk, (C) 1996. + + This library is free software; you can redistribute it and/or modify + it under the terms of the GNU Library General Public License as + published by the Free Software Foundation; either version 2 of the + License, or (at your option) any later version. + +Most of pgtypes.h was removed by John Goerzen since it was not +relevant for this task. diff --git a/Database/HDBC/PostgreSQL.hs b/Database/HDBC/PostgreSQL.hs new file mode 100644 --- /dev/null +++ b/Database/HDBC/PostgreSQL.hs @@ -0,0 +1,41 @@ +{- +Copyright (C) 2005 John Goerzen + + 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 +-} + +{- | + Module : Database.HDBC.PostgreSQL + Copyright : Copyright (C) 2005 John Goerzen + License : GNU LGPL, version 2.1 or above + + Maintainer : John Goerzen + Stability : provisional + Portability: portable + +HDBC driver interface for PostgreSQL 8.x + +Written by John Goerzen, jgoerzen\@complete.org +-} + +module Database.HDBC.PostgreSQL + ( + connectPostgreSQL + ) + +where + +import Database.HDBC.PostgreSQL.Connection(connectPostgreSQL) + diff --git a/Database/HDBC/PostgreSQL/Connection.hsc b/Database/HDBC/PostgreSQL/Connection.hsc new file mode 100644 --- /dev/null +++ b/Database/HDBC/PostgreSQL/Connection.hsc @@ -0,0 +1,151 @@ +-- -*- mode: haskell; -*- +{-# CFILES hdbc-postgresql-helper.c #-} +-- Above line for hugs +{- +Copyright (C) 2005-2006 John Goerzen + + 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 +-} + +module Database.HDBC.PostgreSQL.Connection (connectPostgreSQL) where + +import Database.HDBC.Types +import Database.HDBC +import Database.HDBC.DriverUtils +import Database.HDBC.PostgreSQL.Types +import Database.HDBC.PostgreSQL.Statement +import Database.HDBC.PostgreSQL.PTypeConv +import Foreign.C.Types +import Foreign.C.String +import Foreign.Marshal +import Foreign.Storable +import Database.HDBC.PostgreSQL.Utils +import Foreign.ForeignPtr +import Foreign.Ptr +import Data.Word +import Control.Concurrent.MVar + +#include +#include + +{- | Connect to a PostgreSQL server. + +See for the meaning +of the connection string. -} +connectPostgreSQL :: String -> IO Connection +connectPostgreSQL args = withCString args $ + \cs -> do ptr <- pqconnectdb cs + status <- pqstatus ptr + wrappedptr <- wrapconn ptr nullPtr + fptr <- newForeignPtr pqfinishptr wrappedptr + case status of + #{const CONNECTION_OK} -> mkConn args fptr + _ -> raiseError "connectPostgreSQL" status ptr + +-- FIXME: environment vars may have changed, should use pgsql enquiries +-- for clone. +mkConn :: String -> Conn -> IO Connection +mkConn args conn = withConn conn $ + \cconn -> + do children <- newMVar [] + begin_transaction conn children + protover <- pqprotocolVersion cconn + serverver <- pqserverVersion cconn + let clientver = #{const_str PG_VERSION} + return $ Connection { + disconnect = fdisconnect conn children, + commit = fcommit conn children, + rollback = frollback conn children, + run = frun conn children, + prepare = newSth conn children, + clone = connectPostgreSQL args, + hdbcDriverName = "postgresql", + hdbcClientVer = clientver, + proxiedClientName = "postgresql", + proxiedClientVer = show protover, + dbServerVer = show serverver, + dbTransactionSupport = True, + getTables = fgetTables conn children, + describeTable = fdescribeTable conn children} + +-------------------------------------------------- +-- Guts here +-------------------------------------------------- + +begin_transaction :: Conn -> ChildList -> IO () +begin_transaction o children = frun o children "BEGIN" [] >> return () + +frun o children query args = + do sth <- newSth o children query + res <- execute sth args + finish sth + return res + +fcommit o cl = do frun o cl "COMMIT" [] + begin_transaction o cl +frollback o cl = do frun o cl "ROLLBACK" [] + begin_transaction o cl + +fgetTables conn children = + do sth <- newSth conn children "select table_name from information_schema.tables where table_schema = 'public'" + execute sth [] + res1 <- fetchAllRows sth + let res = map fromSql $ concat res1 + return $ seq (length res) res + +fdescribeTable o cl table = + do sth <- newSth o cl + ("select attname, atttypid, attlen, attnum, attnotnull " ++ + "from pg_attribute, pg_class " ++ + "where relname = ? and attnum > 0 and " ++ + "attrelid = pg_class.oid order by attnum") + execute sth [SqlString table] + res <- fetchAllRows sth + return $ map desccol res + where desccol [attname, atttypid, attlen, attnum, attnotnull] = + let coldef = oidToColDef (fromSql atttypid) + in (fromSql attname, + coldef {colSize = case fromSql attlen of + -1 -> Nothing + x -> Just x, + colNullable = Just ((fromSql attnotnull) == 'f')} + ) + desccol x = + error $ "Got unexpected result from pg_attribute: " ++ show x + +fdisconnect conn mchildren = + do closeAllChildren mchildren + withRawConn conn $ pqfinish + +foreign import ccall unsafe "libpq-fe.h PQconnectdb" + pqconnectdb :: CString -> IO (Ptr CConn) + +foreign import ccall unsafe "hdbc-postgresql-helper.h wrapobjpg" + wrapconn :: Ptr CConn -> Ptr WrappedCConn -> IO (Ptr WrappedCConn) + +foreign import ccall unsafe "libpq-fe.h PQstatus" + pqstatus :: Ptr CConn -> IO #{type ConnStatusType} + +foreign import ccall unsafe "hdbc-postgresql-helper.h PQfinish_app" + pqfinish :: Ptr WrappedCConn -> IO () + +foreign import ccall unsafe "hdbc-postgresql-helper.h &PQfinish_finalizer" + pqfinishptr :: FunPtr (Ptr WrappedCConn -> IO ()) + +foreign import ccall unsafe "libpq-fe.h PQprotocolVersion" + pqprotocolVersion :: Ptr CConn -> IO CInt + +foreign import ccall unsafe "libpq-fe.h PQserverVersion" + pqserverVersion :: Ptr CConn -> IO CInt diff --git a/Database/HDBC/PostgreSQL/PTypeConv.hsc b/Database/HDBC/PostgreSQL/PTypeConv.hsc new file mode 100644 --- /dev/null +++ b/Database/HDBC/PostgreSQL/PTypeConv.hsc @@ -0,0 +1,64 @@ +-- -*- mode: haskell; -*- +{- +Copyright (C) 2006 John Goerzen + + 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 +-} + +module Database.HDBC.PostgreSQL.PTypeConv where +import Database.HDBC.ColTypes +import Data.Word +import Data.Int + +#include "pgtypes.h" +#include + + +oidToColDef :: #{type Oid} -> SqlColDesc +oidToColDef oid = + SqlColDesc {colType = (oidToColType oid), + colSize = Nothing, + colOctetLength = Nothing, + colDecDigits = Nothing, + colNullable = Nothing} + +oidToColType :: #{type Oid} -> SqlTypeId +oidToColType oid = + case oid of + #{const PG_TYPE_CHAR} -> SqlCharT + #{const PG_TYPE_CHAR2} -> SqlCharT + #{const PG_TYPE_CHAR4} -> SqlCharT + #{const PG_TYPE_CHAR8} -> SqlCharT + #{const PG_TYPE_NAME} -> SqlVarCharT + #{const PG_TYPE_BPCHAR} -> SqlCharT + #{const PG_TYPE_VARCHAR} -> SqlVarCharT + #{const PG_TYPE_TEXT} -> SqlVarCharT + #{const PG_TYPE_BYTEA} -> SqlVarBinaryT + #{const PG_TYPE_INT2} -> SqlSmallIntT + #{const PG_TYPE_OID} -> SqlIntegerT + #{const PG_TYPE_XID} -> SqlIntegerT + #{const PG_TYPE_INT4} -> SqlBigIntT + #{const PG_TYPE_INT8} -> SqlBigIntT + #{const PG_TYPE_NUMERIC} -> SqlNumericT + #{const PG_TYPE_FLOAT4} -> SqlRealT + #{const PG_TYPE_FLOAT8} -> SqlFloatT + #{const PG_TYPE_DATE} -> SqlDateT + #{const PG_TYPE_ABSTIME} -> SqlTimestampT + #{const PG_TYPE_DATETIME} -> SqlTimestampT + #{const PG_TYPE_TIMESTAMP_NO_TMZONE} -> SqlTimestampT + #{const PG_TYPE_TIMESTAMP} -> SqlTimestampT + #{const PG_TYPE_MONEY} -> SqlFloatT + #{const PG_TYPE_BOOL} -> SqlBitT + x -> SqlUnknownT (show x) diff --git a/Database/HDBC/PostgreSQL/Parser.hs b/Database/HDBC/PostgreSQL/Parser.hs new file mode 100644 --- /dev/null +++ b/Database/HDBC/PostgreSQL/Parser.hs @@ -0,0 +1,68 @@ +{- -*- mode: haskell; -*- +Copyright (C) 2005 John Goerzen + + 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 +-} + +{- PostgreSQL uses $1, $2, etc. instead of ? in query strings. So we have to +do some basic parsing on these things to fix 'em up. -} + +module Database.HDBC.PostgreSQL.Parser where + +import Text.ParserCombinators.Parsec + +escapeseq = (try $ string "''") <|> + (try $ string "\\'") + +literal = do char '\'' + s <- many (escapeseq <|> (noneOf "'" >>= (\x -> return [x]))) + char '\'' + return $ "'" ++ (concat s) ++ "'" + +qidentifier = do char '"' + s <- many (noneOf "\"") + char '"' + return $ "\"" ++ s ++ "\"" + +comment = ccomment <|> linecomment + +ccomment = do string "/*" + c <- manyTill ((try ccomment) <|> + (anyChar >>= (\x -> return [x]))) + (try (string "*/")) + return $ "/*" ++ concat c ++ "*/" + +linecomment = do string "--" + c <- many (noneOf "\n") + char '\n' + return $ "--" ++ c ++ "\n" + +-- FIXME: handle pgsql dollar-quoted constants + +qmark = do char '?' + n <- getState + updateState (+1) + return $ "$" ++ show n + +statement = + do s <- many ((try qmark) <|> + (try comment) <|> + (try literal) <|> + (try qidentifier) <|> + (anyChar >>= (\x -> return [x]))) + return $ concat s + +convertSQL :: String -> Either ParseError String +convertSQL input = runParser statement 1 "" input diff --git a/Database/HDBC/PostgreSQL/Statement.hsc b/Database/HDBC/PostgreSQL/Statement.hsc new file mode 100644 --- /dev/null +++ b/Database/HDBC/PostgreSQL/Statement.hsc @@ -0,0 +1,246 @@ +-- -*- mode: haskell; -*- +{-# CFILES hdbc-postgresql-helper.c #-} +-- Above line for hugs +{- +Copyright (C) 2005 John Goerzen + + 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 +-} +module Database.HDBC.PostgreSQL.Statement where +import Database.HDBC.Types +import Database.HDBC +import Database.HDBC.PostgreSQL.Types +import Database.HDBC.PostgreSQL.Utils +import Foreign.C.Types +import Foreign.ForeignPtr +import Foreign.Ptr +import Control.Concurrent.MVar +import Foreign.C.String +import Foreign.Marshal +import Foreign.Storable +import Control.Monad +import Data.List +import Data.Word +import Control.Exception +import System.IO +import Database.HDBC.PostgreSQL.Parser(convertSQL) +import Database.HDBC.DriverUtils +import Database.HDBC.PostgreSQL.PTypeConv + +l _ = return () +--l m = hPutStrLn stderr ("\n" ++ m) + +#include + +data SState = + SState { stomv :: MVar (Maybe Stmt), + nextrowmv :: MVar (CInt), -- -1 for no next row (empty); otherwise, next row to read. + dbo :: Conn, + squery :: String, + coldefmv :: MVar [(String, SqlColDesc)]} + +-- FIXME: we currently do no prepare optimization whatsoever. + +newSth :: Conn -> ChildList -> String -> IO Statement +newSth indbo mchildren query = + do l "in newSth" + newstomv <- newMVar Nothing + newnextrowmv <- newMVar (-1) + newcoldefmv <- newMVar [] + usequery <- case convertSQL query of + Left errstr -> throwDyn $ SqlError + {seState = "", + seNativeError = (-1), + seErrorMsg = "hdbc prepare: " ++ + show errstr} + Right converted -> return converted + let sstate = SState {stomv = newstomv, nextrowmv = newnextrowmv, + dbo = indbo, squery = usequery, + coldefmv = newcoldefmv} + let retval = + Statement {execute = fexecute sstate, + executeMany = fexecutemany sstate, + finish = public_ffinish sstate, + fetchRow = ffetchrow sstate, + originalQuery = query, + getColumnNames = fgetColumnNames sstate, + describeResult = fdescribeResult sstate} + addChild mchildren retval + return retval + +fgetColumnNames sstate = + do c <- readMVar (coldefmv sstate) + return (map fst c) + +fdescribeResult sstate = + readMVar (coldefmv sstate) + +{- For now, we try to just handle things as simply as possible. +FIXME lots of room for improvement here (types, etc). -} +fexecute sstate args = withConn (dbo sstate) $ \cconn -> + withCString (squery sstate) $ \cquery -> + withCStringArr0 args $ \cargs -> + do l "in fexecute" + public_ffinish sstate -- Sets nextrowmv to -1 + resptr <- pqexecParams cconn cquery + (genericLength args) nullPtr cargs nullPtr nullPtr 0 + status <- pqresultStatus resptr + case status of + #{const PGRES_EMPTY_QUERY} -> + do l $ "PGRES_EMPTY_QUERY: " ++ squery sstate + pqclear_raw resptr + swapMVar (coldefmv sstate) [] + return 0 + #{const PGRES_COMMAND_OK} -> + do l $ "PGRES_COMMAND_OK: " ++ squery sstate + rowscs <- pqcmdTuples resptr + rows <- peekCString rowscs + pqclear_raw resptr + swapMVar (coldefmv sstate) [] + return $ case rows of + "" -> 0 + x -> read x + #{const PGRES_TUPLES_OK} -> + do l $ "PGRES_TUPLES_OK: " ++ squery sstate + fgetcoldef resptr >>= swapMVar (coldefmv sstate) + numrows <- pqntuples resptr + if numrows < 1 + then do pqclear_raw resptr + return 0 + else do + wrappedptr <- withRawConn (dbo sstate) + (\rawconn -> wrapstmt resptr rawconn) + fresptr <- newForeignPtr pqclearptr wrappedptr + swapMVar (nextrowmv sstate) 0 + swapMVar (stomv sstate) (Just fresptr) + return 0 + _ -> do l $ "PGRES ERROR: " ++ squery sstate + csstatusmsg <- pqresStatus status + cserrormsg <- pqresultErrorMessage resptr + statusmsg <- peekCString csstatusmsg + errormsg <- peekCString cserrormsg + pqclear_raw resptr + throwDyn $ + SqlError {seState = "", + seNativeError = fromIntegral status, + seErrorMsg = "execute: " ++ statusmsg ++ + ": " ++ errormsg} +{- General algorithm: find out how many columns we have, check the type +of each to see if it's NULL. If it's not, fetch it as text and return that. +-} + +ffetchrow :: SState -> IO (Maybe [SqlValue]) +ffetchrow sstate = modifyMVar (nextrowmv sstate) dofetchrow + where dofetchrow (-1) = l "ffr -1" >> return ((-1), Nothing) + dofetchrow nextrow = modifyMVar (stomv sstate) $ \stmt -> + case stmt of + Nothing -> l "ffr nos" >> return (stmt, ((-1), Nothing)) + Just cmstmt -> withStmt cmstmt $ \cstmt -> + do l $ "ffetchrow: " ++ show nextrow + numrows <- pqntuples cstmt + l $ "numrows: " ++ show numrows + if nextrow >= numrows + then do l "no more rows" + -- Don't use public_ffinish here + ffinish cmstmt + return (Nothing, ((-1), Nothing)) + else do l "getting stuff" + ncols <- pqnfields cstmt + res <- mapM (getCol cstmt nextrow) + [0..(ncols - 1)] + return (stmt, (nextrow + 1, Just res)) + getCol p row icol = + do isnull <- pqgetisnull p row icol + if isnull /= 0 + then return SqlNull + else do text <- pqgetvalue p row icol + s <- peekCString text + return (SqlString s) + +fgetcoldef cstmt = + do ncols <- pqnfields cstmt + mapM desccol [0..(ncols - 1)] + where desccol i = + do colname <- (pqfname cstmt i >>= peekCString) + coltype <- pqftype cstmt i + --coloctets <- pqfsize + let coldef = oidToColDef coltype + return (colname, coldef) + +-- FIXME: needs a faster algorithm. +fexecutemany :: SState -> [[SqlValue]] -> IO () +fexecutemany sstate arglist = + mapM_ (fexecute sstate) arglist >> return () + +-- Finish and change state +public_ffinish sstate = + do l "public_ffinish" + swapMVar (nextrowmv sstate) (-1) + modifyMVar_ (stomv sstate) worker + where worker Nothing = return Nothing + worker (Just sth) = ffinish sth >> return Nothing + +ffinish :: Stmt -> IO () +ffinish p = withRawStmt p $ pqclear + +foreign import ccall unsafe "libpq-fe.h PQresultStatus" + pqresultStatus :: (Ptr CStmt) -> IO #{type ExecStatusType} + +foreign import ccall unsafe "libpq-fe.h PQexecParams" + pqexecParams :: (Ptr CConn) -> CString -> CInt -> + (Ptr #{type Oid}) -> + (Ptr CString) -> + (Ptr CInt) -> + (Ptr CInt) -> + CInt -> + IO (Ptr CStmt) + +foreign import ccall unsafe "hdbc-postgresql-helper.h PQclear_app" + pqclear :: Ptr WrappedCStmt -> IO () + +foreign import ccall unsafe "hdbc-postgresql-helper.h &PQclear_finalizer" + pqclearptr :: FunPtr (Ptr WrappedCStmt -> IO ()) + +foreign import ccall unsafe "libpq-fe.h PQclear" + pqclear_raw :: Ptr CStmt -> IO () + +foreign import ccall unsafe "hdbc-postgresql-helper.h wrapobjpg" + wrapstmt :: Ptr CStmt -> Ptr WrappedCConn -> IO (Ptr WrappedCStmt) + +foreign import ccall unsafe "libpq-fe.h PQcmdTuples" + pqcmdTuples :: Ptr CStmt -> IO CString +foreign import ccall unsafe "libpq-fe.h PQresStatus" + pqresStatus :: #{type ExecStatusType} -> IO CString + +foreign import ccall unsafe "libpq-fe.h PQresultErrorMessage" + pqresultErrorMessage :: (Ptr CStmt) -> IO CString + +foreign import ccall unsafe "libpq-fe.h PQntuples" + pqntuples :: Ptr CStmt -> IO CInt + +foreign import ccall unsafe "libpq-fe.h PQnfields" + pqnfields :: Ptr CStmt -> IO CInt + +foreign import ccall unsafe "libpq-fe.h PQgetisnull" + pqgetisnull :: Ptr CStmt -> CInt -> CInt -> IO CInt + +foreign import ccall unsafe "libpq-fe.h PQgetvalue" + pqgetvalue :: Ptr CStmt -> CInt -> CInt -> IO CString + +foreign import ccall unsafe "libpq-fe.h PQfname" + pqfname :: Ptr CStmt -> CInt -> IO CString + +foreign import ccall unsafe "libpq-fe.h PQftype" + pqftype :: Ptr CStmt -> CInt -> IO #{type Oid} diff --git a/Database/HDBC/PostgreSQL/Types.hs b/Database/HDBC/PostgreSQL/Types.hs new file mode 100644 --- /dev/null +++ b/Database/HDBC/PostgreSQL/Types.hs @@ -0,0 +1,14 @@ +module Database.HDBC.PostgreSQL.Types +where + +import Foreign.ForeignPtr +import Foreign + +data CConn = CConn +type WrappedCConn = Ptr CConn +type Conn = ForeignPtr WrappedCConn + +data CStmt = CStmt +type WrappedCStmt = Ptr CStmt +type Stmt = ForeignPtr WrappedCStmt + diff --git a/Database/HDBC/PostgreSQL/Utils.hsc b/Database/HDBC/PostgreSQL/Utils.hsc new file mode 100644 --- /dev/null +++ b/Database/HDBC/PostgreSQL/Utils.hsc @@ -0,0 +1,93 @@ +{- -*- mode: haskell; -*- +Copyright (C) 2005 John Goerzen + + 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 +-} + +module Database.HDBC.PostgreSQL.Utils where +import Foreign.C.String +import Foreign.ForeignPtr +import Foreign.Ptr +import Database.HDBC.Types +import Database.HDBC.PostgreSQL.Types +import Foreign.C.Types +import Control.Exception +import Foreign.Storable +import Foreign.Marshal.Array +import Foreign.Marshal.Alloc +import Data.Word + +#include "hdbc-postgresql-helper.h" + +raiseError :: String -> Word32 -> (Ptr CConn) -> IO a +raiseError msg code cconn = + do rc <- pqerrorMessage cconn + str <- peekCString rc + throwDyn $ SqlError {seState = "", + seNativeError = fromIntegral code, + seErrorMsg = msg ++ ": " ++ str} + +{- This is a little hairy. + +We have a Conn object that is actually a finalizeonce wrapper around +the real object. We use withConn to dereference the foreign pointer, +and then extract the pointer to the real object from the finalizeonce struct. + +But, when we close the connection, we need the finalizeonce struct, so that's +done by withRawConn. + +Ditto for statements. -} + +withConn :: Conn -> (Ptr CConn -> IO b) -> IO b +withConn = genericUnwrap + +withRawConn :: Conn -> (Ptr WrappedCConn -> IO b) -> IO b +withRawConn = withForeignPtr + +withStmt :: Stmt -> (Ptr CStmt -> IO b) -> IO b +withStmt = genericUnwrap + +withRawStmt :: Stmt -> (Ptr WrappedCStmt -> IO b) -> IO b +withRawStmt = withForeignPtr + +withCStringArr0 :: [SqlValue] -> (Ptr CString -> IO a) -> IO a +withCStringArr0 inp action = withAnyArr0 convfunc freefunc inp action + where convfunc SqlNull = return nullPtr + convfunc x = newCString (fromSql x) + freefunc x = + if x == nullPtr + then return () + else free x + +withAnyArr0 :: (a -> IO (Ptr b)) -- ^ Function that transforms input data into pointer + -> (Ptr b -> IO ()) -- ^ Function that frees generated data + -> [a] -- ^ List of input data + -> (Ptr (Ptr b) -> IO c) -- ^ Action to run with the C array + -> IO c -- ^ Return value +withAnyArr0 input2ptract freeact inp action = + bracket (mapM input2ptract inp) + (\clist -> mapM_ freeact clist) + (\clist -> withArray0 nullPtr clist action) + + +genericUnwrap :: ForeignPtr (Ptr a) -> (Ptr a -> IO b) -> IO b +genericUnwrap fptr action = withForeignPtr fptr (\structptr -> + do objptr <- #{peek finalizeonce, encapobj} structptr + action objptr + ) + +foreign import ccall unsafe "libpq-fe.h PQerrorMessage" + pqerrorMessage :: Ptr CConn -> IO CString + diff --git a/HDBC-postgresql.cabal b/HDBC-postgresql.cabal new file mode 100644 --- /dev/null +++ b/HDBC-postgresql.cabal @@ -0,0 +1,22 @@ +Extra-Libraries: pq +include-dirs: /usr/include/postgresql, . +-- extra-lib-dirs: +Name: HDBC-postgresql +Version: 1.0.1.0 +License: LGPL +Maintainer: John Goerzen +Stability: Alpha +Copyright: Copyright (c) 2005-2006 John Goerzen +Exposed-Modules: Database.HDBC.PostgreSQL +Other-Modules: Database.HDBC.PostgreSQL.Connection, + Database.HDBC.PostgreSQL.Statement, + Database.HDBC.PostgreSQL.Types, + Database.HDBC.PostgreSQL.Utils, + Database.HDBC.PostgreSQL.Parser, + Database.HDBC.PostgreSQL.PTypeConv +--Extensions: ExistentialQuantification, AllowOverlappingInstances, +-- AllowUndecidableInstances, CPP +Extensions: ExistentialQuantification +Build-Depends: base, mtl, HDBC>=1.0.0, parsec +GHC-Options: -O2 +C-Sources: hdbc-postgresql-helper.c diff --git a/Makefile b/Makefile new file mode 100644 --- /dev/null +++ b/Makefile @@ -0,0 +1,56 @@ +# Copyright (C) 2004 - 2005 John Goerzen +# +# 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 + +GHCPARMS := -fglasgow-exts + +.PHONY: all hugsbuild +all: setup # GHC build + ./setup configure --user + ./setup build + +hugsbuild: setup + ./setup configure --hugs + ./setup build + +setup: Setup.lhs HDBC-postgresql.cabal + ghc -package Cabal Setup.lhs -o setup + +clean: + -./setup clean + -rm -rf html `find . -name "*.o"` `find . -name "*.hi"` \ + `find . -name "*~"` *.a setup dist testsrc/runtests \ + local-pkg doctmp + -rm -rf testtmp/* testtmp* + +testsrc/runtests: all $(wildcard testsrc/*.hs) $(wildcard testsrc/*/*.hs) $(wildcard testsrc/*/*/*.hs) + cd testsrc && ghc --make -package mtl -package HUnit -package MissingH -package HDBC -lpq $(GHCPARMS) -o runtests -i../dist/build:.. ../dist/build/hdbc-postgresql-helper.o runtests.hs + +test-ghc6: testsrc/runtests + testsrc/runtests + +test-hugs: hugsbuild + runhugs -98 +o -P$(PWD)/dist/build:$(PWD)/testsrc: testsrc/runtests.hs + +interact-hugs: + hugs -98 +o -P$(PWD)/dist/build: + +interact-ghci: all + ghci -idist/build -Ldist/build $(GHCPARMS) + +interact: interact-hugs + +test: test-ghc6 test-hugs + diff --git a/README.txt b/README.txt new file mode 100644 --- /dev/null +++ b/README.txt @@ -0,0 +1,70 @@ +Welcome to HDBC, Haskell Database Connectivity. + +This package provides a database backend driver for PostgreSQL. + +Please see HDBC itself for documentation on use. If you don't already +have it, you can browse this documentation at +http://darcs.complete.org/hdbc/doc/index.html. + +This package provides one function in module Database.HDBC.PostgreSQL: + +{- | Connect to a PostgreSQL server. + +See for the meaning +of the connection string. -} +connectPostgreSQL :: String -> IO Connection + +An example would be: +dbh <- connectPostgreSQL "host=localhost dbname=testdb user=foo" + +DIFFERENCES FROM HDBC STANDARD +------------------------------ + +None known at this time. + +PREREQUISITES +------------- + +Before installing this package, you'll need to have HDBC 0.99.0 or +above installed. You can download HDBC from +http://quux.org/devel/hdbc. + +You'll need either GHC 6.4.1 or above, or Hugs 2005xx or above. If +you're using Hugs, you'll also need cpphs (see +http://www.cs.york.ac.uk/fp/cpphs/ if you don't already have it). + +INSTALLATION +------------ + +The steps to install are: + +1) Examine HDBC-postgresql.cabal and edit the include-dirs + line to point to your local PostgreSQL installation. If necessary, + uncomment and edit the extra-lib-dirs line to point to your + local PostgreSQL installation. + +2) ghc --make -o setup Setup.lhs + +3) ./setup configure + +4) ./setup build + +5) ./setup install (as root) + +If you're on Windows, you can omit the leading "./". + +USAGE +----- + +To use with hugs, you'll want to use hugs -98. + +To use with GHC, you'll want to use: + + -package HDBC -package HDBC-postgresql + +Or, with Cabal, use: + + Build-Depends: HDBC>=0.99.0, HDBC-postgresql + +-- John Goerzen + December 2005 diff --git a/Setup.lhs b/Setup.lhs new file mode 100644 --- /dev/null +++ b/Setup.lhs @@ -0,0 +1,6 @@ +#!/usr/bin/env runhugs + +> import Distribution.Simple + +> main = defaultMain + diff --git a/TODO b/TODO new file mode 100644 --- /dev/null +++ b/TODO @@ -0,0 +1,2 @@ +optimize multiple executions and executeMany + diff --git a/debian/changelog b/debian/changelog new file mode 100644 --- /dev/null +++ b/debian/changelog @@ -0,0 +1,38 @@ +hdbc-postgresql (1.0.1.0) unstable; urgency=low + + * Fix unknown column size, such as for text columns + + -- John Goerzen Sat, 22 Jul 2006 07:08:49 -0500 + +hdbc-postgresql (1.0.0.0) unstable; urgency=low + + * Blessing this version as 1.0.0.0 + * Rebuilt with ghc6 6.4.2 for Debian + + -- John Goerzen Thu, 29 Jun 2006 19:01:02 -0500 + +hdbc-postgresql (0.99.2.1) unstable; urgency=low + + * Give wrapobj a unique name so that this module can coexist with ODBC + in a single program. + + -- John Goerzen Tue, 28 Mar 2006 22:19:26 -0600 + +hdbc-postgresql (0.99.2.0) unstable; urgency=low + + * Updated for 0.99.2. + + -- John Goerzen Tue, 28 Mar 2006 05:33:19 -0600 + +hdbc-postgresql (0.99.1.0) unstable; urgency=low + + * Releasing 0.99.1.0, with new memory management and column type + meta information. + + -- John Goerzen Mon, 27 Mar 2006 23:53:21 -0600 + +hdbc-postgresql (0.99.0.0) unstable; urgency=low + + * Initial Release. + + -- John Goerzen Tue, 27 Dec 2005 16:57:21 -0600 diff --git a/debian/compat b/debian/compat new file mode 100644 --- /dev/null +++ b/debian/compat @@ -0,0 +1,1 @@ +4 diff --git a/debian/control b/debian/control new file mode 100644 --- /dev/null +++ b/debian/control @@ -0,0 +1,30 @@ +Source: hdbc-postgresql +Priority: optional +Maintainer: John Goerzen +Build-Depends: debhelper (>= 4.0.0), ghc6 (>= 6.4.2), ghc6 (<< 6.4.2-999), haskell-devscripts (>= 0.5.6), cpphs, haddock, hugs (>= 98.200503.08), libghc6-hdbc-dev (>= 1.0.1), libhugs-hdbc (>= 1.0.1), libpq-dev (>= 8.1.1) +Standards-Version: 3.6.2 +Section: libs + +Package: libghc6-hdbc-postgresql-dev +Section: libdevel +Architecture: any +Depends: libghc6-hdbc-dev (>= 1.0.1), ${haskell:Depends}, ${shlibs:Depends}, ${misc:Depends}, libpq-dev (>= 8.1.1) +Description: PostgreSQL HDBC (Haskell Database Connectivity) Driver for GHC + HDBC provides an abstraction layer between Haskell programs and SQL + relational databases. This lets you write database code once, in + Haskell, and have it work with any number of backend SQL databases + (MySQL, Oracle, PostgreSQL, ODBC-compliant databases, etc.) + . + This package provides the PostgreSQL database driver for HDBC under GHC. + +Package: libhugs-hdbc-postgresql +Section: libs +Architecture: any +Depends: libhugs-hdbc (>= 0.99.2), ${haskell:Depends}, ${shlibs:Depends}, ${misc:Depends} +Description: PostgreSQL HDBC (Haskell Database Connectivity) Driver for Hugs + HDBC provides an abstraction layer between Haskell programs and SQL + relational databases. This lets you write database code once, in + Haskell, and have it work with any number of backend SQL databases + (MySQL, Oracle, PostgreSQL, ODBC-compliant databases, etc.) + . + This package provides the PostgreSQL database driver for HDBC under Hugs. diff --git a/debian/copyright b/debian/copyright new file mode 100644 --- /dev/null +++ b/debian/copyright @@ -0,0 +1,49 @@ +This is hdbc-postgresql, written and maintained by + John Goerzen +on Tue, 27 Dec 2005 16:57:21 -0600. + +The original source can always be found at: + ftp://ftp.debian.org/dists/unstable/main/source/ + +The Darcs repository for this program can be accessed with: + darcs get --partial http://darcs.complete.org/hdbc-postgresql + +Copyright (C) 2005, 2006 John Goerzen + + 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 + +On Debian systems, the complete text of the GNU Lesser General +Public License can be found in `/usr/share/common-licenses/LGPL'. + +------------------------------------------------------------------ + +pgtypes.h comes from the psqlodbc distribution, which bears this +copyright: + + Copyright (C) 1998 Insight Distribution Systems + Copyright (C) 1998 - 2005 The PostgreSQL Global Development Group + + Multibyte support was added by Sankyo Unyu Service, (C) 2001. + + The code contained in this library is based on code written by + Christian Czezatke and Dan McGuirk, (C) 1996. + + This library is free software; you can redistribute it and/or modify + it under the terms of the GNU Library General Public License as + published by the Free Software Foundation; either version 2 of the + License, or (at your option) any later version. + +Most of pgtypes.h was removed by John Goerzen since it was not +relevant for this task. diff --git a/debian/dirs b/debian/dirs new file mode 100644 --- /dev/null +++ b/debian/dirs @@ -0,0 +1,2 @@ +usr/bin +usr/sbin diff --git a/debian/docs b/debian/docs new file mode 100644 --- /dev/null +++ b/debian/docs @@ -0,0 +1,3 @@ +README.txt +README.txt +TODO diff --git a/debian/rules b/debian/rules new file mode 100644 --- /dev/null +++ b/debian/rules @@ -0,0 +1,111 @@ +#!/usr/bin/make -f +# -*- makefile -*- +# Sample debian/rules that uses debhelper. +# This file was originally written by Joey Hess and Craig Small. +# As a special exception, when this file is copied by dh-make into a +# dh-make output file, you may use that output file without restriction. +# This special exception was added by Craig Small in version 0.37 of dh-make. + +# Uncomment this to turn on verbose mode. +#export DH_VERBOSE=1 + + + + +CFLAGS = -Wall -g + +ifneq (,$(findstring noopt,$(DEB_BUILD_OPTIONS))) + CFLAGS += -O0 +else + CFLAGS += -O2 +endif + +# shared library versions, option 1 +version=2.0.5 +major=2 +# option 2, assuming the library is created as src/.libs/libfoo.so.2.0.5 or so +#version=`ls src/.libs/lib*.so.* | \ +# awk '{if (match($$0,/[0-9]+\.[0-9]+\.[0-9]+$$/)) print substr($$0,RSTART)}'` +#major=`ls src/.libs/lib*.so.* | \ +# awk '{if (match($$0,/\.so\.[0-9]+$$/)) print substr($$0,RSTART+4)}'` + +configure: configure-stamp +configure-stamp: + dh_testdir + # Add here commands to configure the package. + + touch configure-stamp + + +build: build-stamp +build-stamp: configure-stamp + dh_testdir + + # Add here commands to compile the package. + #$(MAKE) + + touch build-stamp + +clean: + dh_testdir + dh_testroot + rm -f build-stamp configure-stamp + + # Add here commands to clean up after the build process. + -$(MAKE) clean + -./setup clean + -rm -rf setup Setup.hi Setup.ho Setup.o .*config* dist + + dh_clean + +install: build + dh_testdir + dh_testroot + dh_clean -k + dh_installdirs + + # Add here commands to install the package into debian/tmp + #$(MAKE) install DESTDIR=$(CURDIR)/debian/tmp + dh_haskell -a +# $(MAKE) clean +# We can't test PostgreSQL because the server may not be available for +# the build user. +#$(MAKE) test + +# Build architecture-independent files here. +binary-indep: build install +# Nothing to do by default. + +# Build architecture-dependent files here. +binary-arch: build install + dh_testdir + dh_testroot + dh_installchangelogs -a + dh_installdocs -a README.txt + dh_installexamples -a +# dh_install +# dh_installmenu +# dh_installdebconf +# dh_installlogrotate +# dh_installemacsen +# dh_installpam +# dh_installmime +# dh_installinit +# dh_installcron +# dh_installinfo + dh_installman -a + dh_link -a + dh_strip -a + dh_compress -a + dh_fixperms -a +# dh_perl +# dh_python +# dh_makeshlibs + dh_installdeb -a + dh_shlibdeps -a + dh_gencontrol -a + dh_md5sums -a + dh_builddeb -a + +binary: binary-indep binary-arch +.PHONY: build clean binary-indep binary-arch binary install configure diff --git a/hdbc-postgresql-helper.c b/hdbc-postgresql-helper.c new file mode 100644 --- /dev/null +++ b/hdbc-postgresql-helper.c @@ -0,0 +1,64 @@ +#include +#include +#include +#include "hdbc-postgresql-helper.h" + +/* Things can't finalize more than once. +We'd like to let people call them from the app. +Yet we'd also like to be able to have a ForeignPtr finalize them. + +So, here's a little wrapper for things. */ + +void PQfinish_conditional_finalizer(finalizeonce *conn); + +finalizeonce *wrapobjpg(void *obj, finalizeonce *parentobj) { + finalizeonce *newobj; + newobj = malloc(sizeof(finalizeonce)); + if (newobj == NULL) { + fprintf(stderr, "HDBC: could not allocate wrapper!\n"); + return NULL; + } + newobj->isfinalized = 0; + newobj->refcount = 1; + newobj->encapobj = obj; + newobj->parent = parentobj; + if (parentobj != NULL) + parentobj->refcount++; + return newobj; +} + +void PQfinish_app(finalizeonce *conn) { + if (conn->isfinalized) + return; + PQfinish((PGconn *) (conn->encapobj)); + conn->isfinalized = 1; +} + +void PQfinish_finalizer(finalizeonce *conn) { + (conn->refcount)--; + PQfinish_conditional_finalizer(conn); +} + +void PQfinish_conditional_finalizer(finalizeonce *conn) { + if (conn->refcount < 1) { + PQfinish_app(conn); + free(conn); + } +} + +void PQclear_app(finalizeonce *res) { + if (res->isfinalized) + return; + PQclear((PGresult *) (res->encapobj)); + res->isfinalized = 1; +} + +void PQclear_finalizer(finalizeonce *res) { + PQclear_app(res); + (res->refcount)--; /* Not really important since this is never a + parent */ + (res->parent->refcount)--; + PQfinish_conditional_finalizer(res->parent); + free(res); +} + diff --git a/hdbc-postgresql-helper.h b/hdbc-postgresql-helper.h new file mode 100644 --- /dev/null +++ b/hdbc-postgresql-helper.h @@ -0,0 +1,16 @@ +#include + +typedef struct TAG_finalizeonce { + void *encapobj; + int refcount; + int isfinalized; + struct TAG_finalizeonce *parent; +} finalizeonce; + +extern finalizeonce *wrapobjpg(void *obj, finalizeonce *parentobj); + +extern void PQfinish_app(finalizeonce *conn); +extern void PQfinish_finalizer(finalizeonce *conn); + +extern void PQclear_app(finalizeonce *res); +extern void PQclear_finalizer(finalizeonce *res); diff --git a/pgtypes.h b/pgtypes.h new file mode 100644 --- /dev/null +++ b/pgtypes.h @@ -0,0 +1,66 @@ +/* File: pgtypes.h + * + * Description: See "pgtypes.c" + * + * Comments: See "notice.txt" for copyright and license information. + * + */ + +#ifndef __PGTYPES_H__ +#define __PGTYPES_H__ + +/* the type numbers are defined by the OID's of the types' rows */ +/* in table pg_type */ + + +#if 0 +#define PG_TYPE_LO ???? /* waiting for permanent type */ +#endif + +#define PG_TYPE_BOOL 16 +#define PG_TYPE_BYTEA 17 +#define PG_TYPE_CHAR 18 +#define PG_TYPE_NAME 19 +#define PG_TYPE_INT8 20 +#define PG_TYPE_INT2 21 +#define PG_TYPE_INT2VECTOR 22 +#define PG_TYPE_INT4 23 +#define PG_TYPE_REGPROC 24 +#define PG_TYPE_TEXT 25 +#define PG_TYPE_OID 26 +#define PG_TYPE_TID 27 +#define PG_TYPE_XID 28 +#define PG_TYPE_CID 29 +#define PG_TYPE_OIDVECTOR 30 +#define PG_TYPE_SET 32 +#define PG_TYPE_CHAR2 409 +#define PG_TYPE_CHAR4 410 +#define PG_TYPE_CHAR8 411 +#define PG_TYPE_POINT 600 +#define PG_TYPE_LSEG 601 +#define PG_TYPE_PATH 602 +#define PG_TYPE_BOX 603 +#define PG_TYPE_POLYGON 604 +#define PG_TYPE_FILENAME 605 +#define PG_TYPE_FLOAT4 700 +#define PG_TYPE_FLOAT8 701 +#define PG_TYPE_ABSTIME 702 +#define PG_TYPE_RELTIME 703 +#define PG_TYPE_TINTERVAL 704 +#define PG_TYPE_UNKNOWN 705 +#define PG_TYPE_MONEY 790 +#define PG_TYPE_OIDINT2 810 +#define PG_TYPE_OIDINT4 910 +#define PG_TYPE_OIDNAME 911 +#define PG_TYPE_BPCHAR 1042 +#define PG_TYPE_VARCHAR 1043 +#define PG_TYPE_DATE 1082 +#define PG_TYPE_TIME 1083 +#define PG_TYPE_TIMESTAMP_NO_TMZONE 1114 /* since 7.2 */ +#define PG_TYPE_DATETIME 1184 +#define PG_TYPE_TIME_WITH_TMZONE 1266 /* since 7.1 */ +#define PG_TYPE_TIMESTAMP 1296 /* deprecated since 7.0 */ +#define PG_TYPE_NUMERIC 1700 +#define INTERNAL_ASIS_TYPE (-9999) + +#endif diff --git a/testsrc/COPYING b/testsrc/COPYING new file mode 100644 --- /dev/null +++ b/testsrc/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/testsrc/COPYRIGHT b/testsrc/COPYRIGHT new file mode 100644 --- /dev/null +++ b/testsrc/COPYRIGHT @@ -0,0 +1,4 @@ +Copyright (c) 2005 John Goerzen + +Please see COPYING for the license. + diff --git a/testsrc/SpecificDB.hs b/testsrc/SpecificDB.hs new file mode 100644 --- /dev/null +++ b/testsrc/SpecificDB.hs @@ -0,0 +1,8 @@ +module SpecificDB where +import Database.HDBC +import Database.HDBC.PostgreSQL +import Database.HDBC.PostgreSQL.Parser(convertSQL) +import Test.HUnit + +connectDB = + handleSqlError (connectPostgreSQL "") diff --git a/testsrc/SpecificDBTests.hs b/testsrc/SpecificDBTests.hs new file mode 100644 --- /dev/null +++ b/testsrc/SpecificDBTests.hs @@ -0,0 +1,24 @@ +module SpecificDBTests where +import Database.HDBC +import Database.HDBC.PostgreSQL +import Database.HDBC.PostgreSQL.Parser(convertSQL) +import Test.HUnit + +testp inp exp = TestCase $ + case convertSQL inp of + Right x -> assertEqual "" exp x + Left y -> assertFailure $ show y + +tests = TestList + [TestLabel "empty" (testp "" ""), + TestLabel "simple" (testp "SELECT a from b WHERE c = ?" + "SELECT a from b WHERE c = $1"), + TestLabel "multi" (testp "INSERT INTO foo VALUES (?,?)" + "INSERT INTO foo VALUES ($1,$2)"), + TestLabel "literal" (testp "INSERT INTO foo VALUES ('?', '''?')" + "INSERT INTO foo VALUES ('?', '''?')"), + TestLabel "torture" + (testp "-- really?\n-- yes'?\nINSERT INTO ? VALUES ('', ?, \"?asd\", '?\\'?', '?''?', /* foo? */ /* foo /* bar */ ? */ ?)" + "-- really?\n-- yes'?\nINSERT INTO $1 VALUES ('', $2, \"?asd\", '?\\'?', '?''?', /* foo? */ /* foo /* bar */ ? */ $3)") + ] + diff --git a/testsrc/TestMisc.hs b/testsrc/TestMisc.hs new file mode 100644 --- /dev/null +++ b/testsrc/TestMisc.hs @@ -0,0 +1,170 @@ +module TestMisc(tests, setup) where +import Test.HUnit +import Database.HDBC +import TestUtils +import System.IO +import Control.Exception +import Data.Char +import Control.Monad +import qualified Data.Map as Map + +rowdata = + [[SqlInt32 0, toSql "Testing", SqlNull], + [SqlInt32 1, toSql "Foo", SqlInt32 5], + [SqlInt32 2, toSql "Bar", SqlInt32 9]] + +colnames = ["testid", "teststring", "testint"] +alrows :: [[(String, SqlValue)]] +alrows = map (zip colnames) rowdata + +setup f = dbTestCase $ \dbh -> + do run dbh "CREATE TABLE hdbctest2 (testid INTEGER PRIMARY KEY NOT NULL, teststring TEXT, testint INTEGER)" [] + sth <- prepare dbh "INSERT INTO hdbctest2 VALUES (?, ?, ?)" + executeMany sth rowdata + commit dbh + finally (f dbh) + (do run dbh "DROP TABLE hdbctest2" [] + commit dbh + ) + +cloneTest dbh a = + do dbh2 <- clone dbh + finally (handleSqlError (a dbh2)) + (handleSqlError (disconnect dbh2)) + +testgetColumnNames = setup $ \dbh -> + do sth <- prepare dbh "SELECT * from hdbctest2" + execute sth [] + cols <- getColumnNames sth + finish sth + ["testid", "teststring", "testint"] @=? map (map toLower) cols + +testdescribeResult = setup $ \dbh -> when (not ((hdbcDriverName dbh) `elem` + ["sqlite3"])) $ + do sth <- prepare dbh "SELECT * from hdbctest2" + execute sth [] + cols <- describeResult sth + ["testid", "teststring", "testint"] @=? map (map toLower . fst) cols + let coldata = map snd cols + assertBool "r0 type" (colType (coldata !! 0) `elem` + [SqlBigIntT, SqlIntegerT]) + assertBool "r1 type" (colType (coldata !! 1) `elem` + [SqlVarCharT, SqlLongVarCharT]) + assertBool "r2 type" (colType (coldata !! 2) `elem` + [SqlBigIntT, SqlIntegerT]) + finish sth + +testdescribeTable = setup $ \dbh -> when (not ((hdbcDriverName dbh) `elem` + ["sqlite3"])) $ + do cols <- describeTable dbh "hdbctest2" + ["testid", "teststring", "testint"] @=? map (map toLower . fst) cols + let coldata = map snd cols + assertBool "r0 type" (colType (coldata !! 0) `elem` + [SqlBigIntT, SqlIntegerT]) + assertEqual "r0 nullable" (Just False) (colNullable (coldata !! 0)) + assertBool "r1 type" (colType (coldata !! 1) `elem` + [SqlVarCharT, SqlLongVarCharT]) + assertEqual "r1 nullable" (Just True) (colNullable (coldata !! 1)) + assertBool "r2 type" (colType (coldata !! 2) `elem` + [SqlBigIntT, SqlIntegerT]) + assertEqual "r2 nullable" (Just True) (colNullable (coldata !! 2)) + +testquickQuery = setup $ \dbh -> + do results <- quickQuery dbh "SELECT * from hdbctest2 ORDER BY testid" [] + rowdata @=? results + +testfetchRowAL = setup $ \dbh -> + do sth <- prepare dbh "SELECT * from hdbctest2 ORDER BY testid" + execute sth [] + fetchRowAL sth >>= (Just (head alrows) @=?) + fetchRowAL sth >>= (Just (alrows !! 1) @=?) + fetchRowAL sth >>= (Just (alrows !! 2) @=?) + fetchRowAL sth >>= (Nothing @=?) + finish sth + +testfetchRowMap = setup $ \dbh -> + do sth <- prepare dbh "SELECT * from hdbctest2 ORDER BY testid" + execute sth [] + fetchRowMap sth >>= (Just (Map.fromList $ head alrows) @=?) + fetchRowMap sth >>= (Just (Map.fromList $ alrows !! 1) @=?) + fetchRowMap sth >>= (Just (Map.fromList $ alrows !! 2) @=?) + fetchRowMap sth >>= (Nothing @=?) + finish sth + +testfetchAllRowsAL = setup $ \dbh -> + do sth <- prepare dbh "SELECT * from hdbctest2 ORDER BY testid" + execute sth [] + fetchAllRowsAL sth >>= (alrows @=?) + +testfetchAllRowsMap = setup $ \dbh -> + do sth <- prepare dbh "SELECT * from hdbctest2 ORDER BY testid" + execute sth [] + fetchAllRowsMap sth >>= (map (Map.fromList) alrows @=?) + +testexception = setup $ \dbh -> + catchSql (do sth <- prepare dbh "SELECT invalidcol FROM hdbctest2" + execute sth [] + assertFailure "No exception was raised" + ) + (\e -> commit dbh) + +testrowcount = setup $ \dbh -> + do r <- run dbh "UPDATE hdbctest2 SET testint = 25 WHERE testid = 20" [] + assertEqual "UPDATE with no change" 0 r + r <- run dbh "UPDATE hdbctest2 SET testint = 26 WHERE testid = 0" [] + assertEqual "UPDATE with 1 change" 1 r + r <- run dbh "UPDATE hdbctest2 SET testint = 27 WHERE testid <> 0" [] + assertEqual "UPDATE with 2 changes" 2 r + commit dbh + res <- quickQuery dbh "SELECT * from hdbctest2 ORDER BY testid" [] + assertEqual "final results" + [[SqlInt32 0, toSql "Testing", SqlInt32 26], + [SqlInt32 1, toSql "Foo", SqlInt32 27], + [SqlInt32 2, toSql "Bar", SqlInt32 27]] res + +{- Since we might be running against a live DB, we can't look at a specific +list here (though a SpecificDB test case may be able to). We can ensure +that our test table is, or is not, present, as appropriate. -} + +testgetTables1 = setup $ \dbh -> + do r <- getTables dbh + True @=? "hdbctest2" `elem` r + +testgetTables2 = dbTestCase $ \dbh -> + do r <- getTables dbh + False @=? "hdbctest2" `elem` r + +testclone = setup $ \dbho -> cloneTest dbho $ \dbh -> + do results <- quickQuery dbh "SELECT * from hdbctest2 ORDER BY testid" [] + rowdata @=? results + +testnulls = setup $ \dbh -> + do let dn = hdbcDriverName dbh + when (not (dn `elem` ["postgresql", "odbc"])) ( + do sth <- prepare dbh "INSERT INTO hdbctest2 VALUES (?, ?, ?)" + executeMany sth rows + finish sth + res <- quickQuery dbh "SELECT * from hdbctest2 WHERE testid > 99 ORDER BY testid" [] + seq (length res) rows @=? res + ) + where rows = [[SqlInt32 100, SqlString "foo\NULbar", SqlNull], + [SqlInt32 101, SqlString "bar\NUL", SqlNull], + [SqlInt32 102, SqlString "\NUL", SqlNull], + [SqlInt32 103, SqlString "\xFF", SqlNull], + [SqlInt32 104, SqlString "regular", SqlNull]] + + +tests = TestList [TestLabel "getColumnNames" testgetColumnNames, + TestLabel "describeResult" testdescribeResult, + TestLabel "describeTable" testdescribeTable, + TestLabel "quickQuery" testquickQuery, + TestLabel "fetchRowAL" testfetchRowAL, + TestLabel "fetchRowMap" testfetchRowMap, + TestLabel "fetchAllRowsAL" testfetchAllRowsAL, + TestLabel "fetchAllRowsMap" testfetchAllRowsMap, + TestLabel "sql exception" testexception, + TestLabel "clone" testclone, + TestLabel "update rowcount" testrowcount, + TestLabel "get tables1" testgetTables1, + TestLabel "get tables2" testgetTables2, + TestLabel "nulls" testnulls] diff --git a/testsrc/TestSbasics.hs b/testsrc/TestSbasics.hs new file mode 100644 --- /dev/null +++ b/testsrc/TestSbasics.hs @@ -0,0 +1,149 @@ +module TestSbasics(tests) where +import Test.HUnit +import Database.HDBC +import TestUtils +import System.IO +import Control.Exception + +openClosedb = sqlTestCase $ + do dbh <- connectDB + disconnect dbh + +multiFinish = dbTestCase (\dbh -> + do sth <- prepare dbh "SELECT 1 + 1" + sExecute sth [] + finish sth + finish sth + finish sth + ) + +basicQueries = dbTestCase (\dbh -> + do sth <- prepare dbh "SELECT 1 + 1" + sExecute sth [] + sFetchRow sth >>= (assertEqual "row 1" (Just [Just "2"])) + sFetchRow sth >>= (assertEqual "last row" Nothing) + ) + +createTable = dbTestCase (\dbh -> + do sRun dbh "CREATE TABLE hdbctest1 (testname VARCHAR(20), testid INTEGER, testint INTEGER, testtext TEXT)" [] + commit dbh + ) + +dropTable = dbTestCase (\dbh -> + do sRun dbh "DROP TABLE hdbctest1" [] + commit dbh + ) + +runReplace = dbTestCase (\dbh -> + do sRun dbh "INSERT INTO hdbctest1 VALUES (?, ?, ?, ?)" r1 + sRun dbh "INSERT INTO hdbctest1 VALUES (?, ?, 2, ?)" r2 + commit dbh + sth <- prepare dbh "SELECT * FROM hdbctest1 WHERE testname = 'runReplace' ORDER BY testid" + sExecute sth [] + sFetchRow sth >>= (assertEqual "r1" (Just r1)) + sFetchRow sth >>= (assertEqual "r2" (Just [Just "runReplace", Just "2", + Just "2", Nothing])) + sFetchRow sth >>= (assertEqual "lastrow" Nothing) + ) + where r1 = [Just "runReplace", Just "1", Just "1234", Just "testdata"] + r2 = [Just "runReplace", Just "2", Nothing] + +executeReplace = dbTestCase (\dbh -> + do sth <- prepare dbh "INSERT INTO hdbctest1 VALUES ('executeReplace',?,?,?)" + sExecute sth [Just "1", Just "1234", Just "Foo"] + sExecute sth [Just "2", Nothing, Just "Bar"] + commit dbh + sth <- prepare dbh "SELECT * FROM hdbctest1 WHERE testname = ? ORDER BY testid" + sExecute sth [Just "executeReplace"] + sFetchRow sth >>= (assertEqual "r1" + (Just $ map Just ["executeReplace", "1", "1234", + "Foo"])) + sFetchRow sth >>= (assertEqual "r2" + (Just [Just "executeReplace", Just "2", Nothing, + Just "Bar"])) + sFetchRow sth >>= (assertEqual "lastrow" Nothing) + ) + +testExecuteMany = dbTestCase (\dbh -> + do sth <- prepare dbh "INSERT INTO hdbctest1 VALUES ('multi',?,?,?)" + sExecuteMany sth rows + commit dbh + sth <- prepare dbh "SELECT testid, testint, testtext FROM hdbctest1 WHERE testname = 'multi'" + sExecute sth [] + mapM_ (\r -> sFetchRow sth >>= (assertEqual "" (Just r))) rows + sFetchRow sth >>= (assertEqual "lastrow" Nothing) + ) + where rows = [map Just ["1", "1234", "foo"], + map Just ["2", "1341", "bar"], + [Just "3", Nothing, Nothing]] + +testsFetchAllRows = dbTestCase (\dbh -> + do sth <- prepare dbh "INSERT INTO hdbctest1 VALUES ('sFetchAllRows', ?, NULL, NULL)" + sExecuteMany sth rows + commit dbh + sth <- prepare dbh "SELECT testid FROM hdbctest1 WHERE testname = 'sFetchAllRows' ORDER BY testid" + sExecute sth [] + results <- sFetchAllRows sth + assertEqual "" rows results + ) + where rows = map (\x -> [Just . show $ x]) [1..9] + +basicTransactions = dbTestCase (\dbh -> + do assertBool "Connected database does not support transactions; skipping transaction test" (dbTransactionSupport dbh) + sth <- prepare dbh "INSERT INTO hdbctest1 VALUES ('basicTransactions', ?, NULL, NULL)" + sExecute sth [Just "0"] + commit dbh + qrysth <- prepare dbh "SELECT testid FROM hdbctest1 WHERE testname = 'basicTransactions' ORDER BY testid" + sExecute qrysth [] + sFetchAllRows qrysth >>= (assertEqual "initial commit" [[Just "0"]]) + + -- Now try a rollback + sExecuteMany sth rows + rollback dbh + sExecute qrysth [] + sFetchAllRows qrysth >>= (assertEqual "rollback" [[Just "0"]]) + + -- Now try another commit + sExecuteMany sth rows + commit dbh + sExecute qrysth [] + sFetchAllRows qrysth >>= (assertEqual "final commit" ([Just "0"]:rows)) + ) + where rows = map (\x -> [Just . show $ x]) [1..9] + +testWithTransaction = dbTestCase (\dbh -> + do assertBool "Connected database does not support transactions; skipping transaction test" (dbTransactionSupport dbh) + sth <- prepare dbh "INSERT INTO hdbctest1 VALUES ('withTransaction', ?, NULL, NULL)" + sExecute sth [Just "0"] + commit dbh + qrysth <- prepare dbh "SELECT testid FROM hdbctest1 WHERE testname = 'withTransaction' ORDER BY testid" + sExecute qrysth [] + sFetchAllRows qrysth >>= (assertEqual "initial commit" [[Just "0"]]) + + -- Let's try a rollback. + try $ withTransaction dbh (\_ -> do sExecuteMany sth rows + fail "Foo") + sExecute qrysth [] + sFetchAllRows qrysth >>= (assertEqual "rollback" [[Just "0"]]) + + -- And now a commit. + withTransaction dbh (\_ -> sExecuteMany sth rows) + sExecute qrysth [] + sFetchAllRows qrysth >>= (assertEqual "final commit" ([Just "0"]:rows)) + ) + where rows = map (\x -> [Just . show $ x]) [1..9] + +tests = TestList + [ + TestLabel "openClosedb" openClosedb, + TestLabel "multiFinish" multiFinish, + TestLabel "basicQueries" basicQueries, + TestLabel "createTable" createTable, + TestLabel "runReplace" runReplace, + TestLabel "executeReplace" executeReplace, + TestLabel "executeMany" testExecuteMany, + TestLabel "sFetchAllRows" testsFetchAllRows, + TestLabel "basicTransactions" basicTransactions, + TestLabel "withTransaction" testWithTransaction, + TestLabel "dropTable" dropTable + ] diff --git a/testsrc/TestUtils.hs b/testsrc/TestUtils.hs new file mode 100644 --- /dev/null +++ b/testsrc/TestUtils.hs @@ -0,0 +1,25 @@ +module TestUtils(connectDB, sqlTestCase, dbTestCase, printDBInfo) where +import Database.HDBC +import Test.HUnit +import Control.Exception +import SpecificDB(connectDB) + +sqlTestCase a = + TestCase (handleSqlError a) + +dbTestCase a = + TestCase (do dbh <- connectDB + finally (handleSqlError (a dbh)) + (handleSqlError (disconnect dbh)) + ) + +printDBInfo = handleSqlError $ + do dbh <- connectDB + putStrLn "+-------------------------------------------------------------------------" + putStrLn $ "| Testing HDBC database module: " ++ hdbcDriverName dbh ++ + ", bound to client: " ++ hdbcClientVer dbh + putStrLn $ "| Proxied driver: " ++ proxiedClientName dbh ++ + ", bound to version: " ++ proxiedClientVer dbh + putStrLn $ "| Connected to server version: " ++ dbServerVer dbh + putStrLn "+-------------------------------------------------------------------------\n" + disconnect dbh diff --git a/testsrc/Testbasics.hs b/testsrc/Testbasics.hs new file mode 100644 --- /dev/null +++ b/testsrc/Testbasics.hs @@ -0,0 +1,155 @@ +module Testbasics(tests) where +import Test.HUnit +import Database.HDBC +import TestUtils +import System.IO +import Control.Exception + +openClosedb = sqlTestCase $ + do dbh <- connectDB + disconnect dbh + +multiFinish = dbTestCase (\dbh -> + do sth <- prepare dbh "SELECT 1 + 1" + r <- execute sth [] + assertEqual "basic count" 0 r + finish sth + finish sth + finish sth + ) + +basicQueries = dbTestCase (\dbh -> + do sth <- prepare dbh "SELECT 1 + 1" + execute sth [] >>= (0 @=?) + r <- fetchAllRows sth + assertEqual "converted from" [["2"]] (map (map fromSql) r) + assertEqual "int32 compare" [[SqlInt32 2]] r + assertEqual "iToSql compare" [[iToSql 2]] r + assertEqual "num compare" [[toSql (2::Int)]] r + assertEqual "nToSql compare" [[nToSql (2::Int)]] r + assertEqual "string compare" [[SqlString "2"]] r + ) + +createTable = dbTestCase (\dbh -> + do run dbh "CREATE TABLE hdbctest1 (testname VARCHAR(20), testid INTEGER, testint INTEGER, testtext TEXT)" [] + commit dbh + ) + +dropTable = dbTestCase (\dbh -> + do run dbh "DROP TABLE hdbctest1" [] + commit dbh + ) + +runReplace = dbTestCase (\dbh -> + do r <- run dbh "INSERT INTO hdbctest1 VALUES (?, ?, ?, ?)" r1 + assertEqual "insert retval" 1 r + run dbh "INSERT INTO hdbctest1 VALUES (?, ?, ?, ?)" r2 + commit dbh + sth <- prepare dbh "SELECT * FROM hdbctest1 WHERE testname = 'runReplace' ORDER BY testid" + rv2 <- execute sth [] + assertEqual "select retval" 0 rv2 + r <- fetchAllRows sth + assertEqual "" [r1, r2] r + ) + where r1 = [toSql "runReplace", iToSql 1, iToSql 1234, SqlString "testdata"] + r2 = [toSql "runReplace", iToSql 2, iToSql 2, SqlNull] + +executeReplace = dbTestCase (\dbh -> + do sth <- prepare dbh "INSERT INTO hdbctest1 VALUES ('executeReplace',?,?,?)" + execute sth [iToSql 1, iToSql 1234, toSql "Foo"] + execute sth [SqlInt32 2, SqlNull, toSql "Bar"] + commit dbh + sth <- prepare dbh "SELECT * FROM hdbctest1 WHERE testname = ? ORDER BY testid" + execute sth [SqlString "executeReplace"] + r <- fetchAllRows sth + assertEqual "result" + [[toSql "executeReplace", iToSql 1, toSql "1234", + toSql "Foo"], + [toSql "executeReplace", iToSql 2, SqlNull, + toSql "Bar"]] + r + ) + +testExecuteMany = dbTestCase (\dbh -> + do sth <- prepare dbh "INSERT INTO hdbctest1 VALUES ('multi',?,?,?)" + executeMany sth rows + commit dbh + sth <- prepare dbh "SELECT testid, testint, testtext FROM hdbctest1 WHERE testname = 'multi'" + execute sth [] + r <- fetchAllRows sth + assertEqual "" rows r + ) + where rows = [map toSql ["1", "1234", "foo"], + map toSql ["2", "1341", "bar"], + [toSql "3", SqlNull, SqlNull]] + +testFetchAllRows = dbTestCase (\dbh -> + do sth <- prepare dbh "INSERT INTO hdbctest1 VALUES ('sFetchAllRows', ?, NULL, NULL)" + executeMany sth rows + commit dbh + sth <- prepare dbh "SELECT testid FROM hdbctest1 WHERE testname = 'sFetchAllRows' ORDER BY testid" + execute sth [] + results <- fetchAllRows sth + assertEqual "" rows results + ) + where rows = map (\x -> [iToSql x]) [1..9] + +basicTransactions = dbTestCase (\dbh -> + do assertBool "Connected database does not support transactions; skipping transaction test" (dbTransactionSupport dbh) + sth <- prepare dbh "INSERT INTO hdbctest1 VALUES ('basicTransactions', ?, NULL, NULL)" + execute sth [iToSql 0] + commit dbh + qrysth <- prepare dbh "SELECT testid FROM hdbctest1 WHERE testname = 'basicTransactions' ORDER BY testid" + execute qrysth [] + fetchAllRows qrysth >>= (assertEqual "initial commit" [[toSql "0"]]) + + -- Now try a rollback + executeMany sth rows + rollback dbh + execute qrysth [] + fetchAllRows qrysth >>= (assertEqual "rollback" [[toSql "0"]]) + + -- Now try another commit + executeMany sth rows + commit dbh + execute qrysth [] + fetchAllRows qrysth >>= (assertEqual "final commit" ([SqlString "0"]:rows)) + ) + where rows = map (\x -> [iToSql $ x]) [1..9] + +testWithTransaction = dbTestCase (\dbh -> + do assertBool "Connected database does not support transactions; skipping transaction test" (dbTransactionSupport dbh) + sth <- prepare dbh "INSERT INTO hdbctest1 VALUES ('withTransaction', ?, NULL, NULL)" + execute sth [toSql "0"] + commit dbh + qrysth <- prepare dbh "SELECT testid FROM hdbctest1 WHERE testname = 'withTransaction' ORDER BY testid" + execute qrysth [] + fetchAllRows qrysth >>= (assertEqual "initial commit" [[toSql "0"]]) + + -- Let's try a rollback. + try $ withTransaction dbh (\_ -> do executeMany sth rows + fail "Foo") + execute qrysth [] + fetchAllRows qrysth >>= (assertEqual "rollback" [[SqlString "0"]]) + + -- And now a commit. + withTransaction dbh (\_ -> executeMany sth rows) + execute qrysth [] + fetchAllRows qrysth >>= (assertEqual "final commit" ([iToSql 0]:rows)) + ) + where rows = map (\x -> [iToSql x]) [1..9] + +tests = TestList + [ + TestLabel "openClosedb" openClosedb, + TestLabel "multiFinish" multiFinish, + TestLabel "basicQueries" basicQueries, + TestLabel "createTable" createTable, + TestLabel "runReplace" runReplace, + TestLabel "executeReplace" executeReplace, + TestLabel "executeMany" testExecuteMany, + TestLabel "sFetchAllRows" testFetchAllRows, + TestLabel "basicTransactions" basicTransactions, + TestLabel "withTransaction" testWithTransaction, + TestLabel "dropTable" dropTable + ] diff --git a/testsrc/Tests.hs b/testsrc/Tests.hs new file mode 100644 --- /dev/null +++ b/testsrc/Tests.hs @@ -0,0 +1,32 @@ +{- arch-tag: Tests main file +Copyright (C) 2004-2005 John Goerzen + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +-} + +module Tests(tests) where +import Test.HUnit +import qualified Testbasics +import qualified TestSbasics +import qualified SpecificDBTests +import qualified TestMisc + +test1 = TestCase ("x" @=? "x") + +tests = TestList [TestLabel "test1" test1, + TestLabel "String basics" TestSbasics.tests, + TestLabel "SqlValue basics" Testbasics.tests, + TestLabel "SpecificDB" SpecificDBTests.tests, + TestLabel "Misc tests" TestMisc.tests] diff --git a/testsrc/runtests.hs b/testsrc/runtests.hs new file mode 100644 --- /dev/null +++ b/testsrc/runtests.hs @@ -0,0 +1,27 @@ +{- arch-tag: Test runner +Copyright (C) 2004 John Goerzen + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +-} + +module Main where + +import Test.HUnit +import Tests +import TestUtils + +main = do printDBInfo + runTestTT tests +