1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
|
{-# LANGUAGE ForeignFunctionInterface, DeriveDataTypeable #-}
{-# LANGUAGE OverloadedStrings #-}
-- | A port of the direct-sqlite package for dealing directly with
-- 'PersistValue's.
module Database.Sqlite (
Connection,
Statement,
Error(..),
StepResult(Row,
Done),
open,
close,
prepare,
step,
reset,
finalize,
bindBlob,
bindDouble,
bindInt,
bindInt64,
bindNull,
bindText,
bind,
column,
columns,
changes
)
where
import Prelude hiding (error)
import qualified Prelude as P
import qualified Prelude
import qualified Data.ByteString as BS
import qualified Data.ByteString.Internal as BSI
import Foreign
import Foreign.C
import Database.Persist (PersistValue (..), listToJSON, mapToJSON, ZT (ZT))
import Data.Text (Text, pack, unpack)
import Data.Text.Encoding (encodeUtf8, decodeUtf8With)
import Data.Text.Encoding.Error (lenientDecode)
import Data.Monoid (mappend, mconcat)
import Data.IORef (IORef, newIORef, readIORef, writeIORef)
import Data.Fixed (Pico)
data Connection = Connection !(IORef Bool) Connection'
newtype Connection' = Connection' (Ptr ())
newtype Statement = Statement (Ptr ())
data Error = ErrorOK
| ErrorError
| ErrorInternal
| ErrorPermission
| ErrorAbort
| ErrorBusy
| ErrorLocked
| ErrorNoMemory
| ErrorReadOnly
| ErrorInterrupt
| ErrorIO
| ErrorNotFound
| ErrorCorrupt
| ErrorFull
| ErrorCan'tOpen
| ErrorProtocol
| ErrorEmpty
| ErrorSchema
| ErrorTooBig
| ErrorConstraint
| ErrorMismatch
| ErrorMisuse
| ErrorNoLargeFileSupport
| ErrorAuthorization
| ErrorFormat
| ErrorRange
| ErrorNotAConnection
| ErrorRow
| ErrorDone
deriving (Eq, Show)
data StepResult = Row | Done deriving (Eq, Show)
data ColumnType = IntegerColumn
| FloatColumn
| TextColumn
| BlobColumn
| NullColumn
deriving (Eq, Show)
decodeError :: Int -> Error
decodeError 0 = ErrorOK
decodeError 1 = ErrorError
decodeError 2 = ErrorInternal
decodeError 3 = ErrorPermission
decodeError 4 = ErrorAbort
decodeError 5 = ErrorBusy
decodeError 6 = ErrorLocked
decodeError 7 = ErrorNoMemory
decodeError 8 = ErrorReadOnly
decodeError 9 = ErrorInterrupt
decodeError 10 = ErrorIO
decodeError 11 = ErrorNotFound
decodeError 12 = ErrorCorrupt
decodeError 13 = ErrorFull
decodeError 14 = ErrorCan'tOpen
decodeError 15 = ErrorProtocol
decodeError 16 = ErrorEmpty
decodeError 17 = ErrorSchema
decodeError 18 = ErrorTooBig
decodeError 19 = ErrorConstraint
decodeError 20 = ErrorMismatch
decodeError 21 = ErrorMisuse
decodeError 22 = ErrorNoLargeFileSupport
decodeError 23 = ErrorAuthorization
decodeError 24 = ErrorFormat
decodeError 25 = ErrorRange
decodeError 26 = ErrorNotAConnection
decodeError 100 = ErrorRow
decodeError 101 = ErrorDone
decodeError i = Prelude.error $ "decodeError " ++ show i
decodeColumnType :: Int -> ColumnType
decodeColumnType 1 = IntegerColumn
decodeColumnType 2 = FloatColumn
decodeColumnType 3 = TextColumn
decodeColumnType 4 = BlobColumn
decodeColumnType 5 = NullColumn
decodeColumnType i = Prelude.error $ "decodeColumnType " ++ show i
foreign import ccall "sqlite3_errmsg"
errmsgC :: Ptr () -> IO CString
errmsg :: Connection -> IO Text
errmsg (Connection _ (Connection' database)) = do
message <- errmsgC database
byteString <- BS.packCString message
return $ decodeUtf8With lenientDecode byteString
sqlError :: Maybe Connection -> Text -> Error -> IO a
sqlError maybeConnection functionName error = do
details <- case maybeConnection of
Just database -> do
details <- errmsg database
return $ ": " `mappend` details
Nothing -> return "."
fail $ unpack $ mconcat
["SQLite3 returned "
, pack $ show error
, " while attempting to perform "
, functionName
, details
]
foreign import ccall "sqlite3_open"
openC :: CString -> Ptr (Ptr ()) -> IO Int
openError :: Text -> IO (Either Connection Error)
openError path' = do
BS.useAsCString (encodeUtf8 path')
(\path -> do
alloca (\database -> do
error' <- openC path database
error <- return $ decodeError error'
case error of
ErrorOK -> do
database' <- peek database
active <- newIORef True
return $ Left $ Connection active $ Connection' database'
_ -> return $ Right error))
open :: Text -> IO Connection
open path = do
databaseOrError <- openError path
case databaseOrError of
Left database -> return database
Right error -> sqlError Nothing ("open " `mappend` (pack $ show path)) error
foreign import ccall "sqlite3_close"
closeC :: Ptr () -> IO Int
closeError :: Connection -> IO Error
closeError (Connection iactive (Connection' database)) = do
writeIORef iactive False
error <- closeC database
return $ decodeError error
close :: Connection -> IO ()
close database = do
error <- closeError database
case error of
ErrorOK -> return ()
_ -> sqlError (Just database) "close" error
foreign import ccall "sqlite3_prepare_v2"
prepareC :: Ptr () -> CString -> Int -> Ptr (Ptr ()) -> Ptr (Ptr ()) -> IO Int
prepareError :: Connection -> Text -> IO (Either Statement Error)
prepareError (Connection _ (Connection' database)) text' = do
BS.useAsCString (encodeUtf8 text')
(\text -> do
alloca (\statement -> do
error' <- prepareC database text (-1) statement nullPtr
error <- return $ decodeError error'
case error of
ErrorOK -> do
statement' <- peek statement
return $ Left $ Statement statement'
_ -> return $ Right error))
prepare :: Connection -> Text -> IO Statement
prepare database text = do
statementOrError <- prepareError database text
case statementOrError of
Left statement -> return statement
Right error -> sqlError (Just database) ("prepare " `mappend` (pack $ show text)) error
foreign import ccall "sqlite3_step"
stepC :: Ptr () -> IO Int
stepError :: Statement -> IO Error
stepError (Statement statement) = do
error <- stepC statement
return $ decodeError error
step :: Statement -> IO StepResult
step statement = do
error <- stepError statement
case error of
ErrorRow -> return Row
ErrorDone -> return Done
_ -> sqlError Nothing "step" error
foreign import ccall "sqlite3_reset"
resetC :: Ptr () -> IO Int
resetError :: Statement -> IO Error
resetError (Statement statement) = do
error <- resetC statement
return $ decodeError error
reset :: Connection -> Statement -> IO ()
reset (Connection iactive _) statement = do
active <- readIORef iactive
if active
then do
error <- resetError statement
case error of
ErrorOK -> return ()
_ -> return () -- FIXME confirm this is correct sqlError Nothing "reset" error
else return ()
foreign import ccall "sqlite3_finalize"
finalizeC :: Ptr () -> IO Int
finalizeError :: Statement -> IO Error
finalizeError (Statement statement) = do
error <- finalizeC statement
return $ decodeError error
finalize :: Statement -> IO ()
finalize statement = do
error <- finalizeError statement
case error of
ErrorOK -> return ()
_ -> return () -- sqlError Nothing "finalize" error
foreign import ccall "sqlite3_bind_blob"
bindBlobC :: Ptr () -> Int -> Ptr () -> Int -> Ptr () -> IO Int
bindBlobError :: Statement -> Int -> BS.ByteString -> IO Error
bindBlobError (Statement statement) parameterIndex byteString = do
size <- return $ BS.length byteString
BS.useAsCString byteString
(\dataC -> do
error <- bindBlobC statement parameterIndex (castPtr dataC) size
(intPtrToPtr (-1))
return $ decodeError error)
bindBlob :: Statement -> Int -> BS.ByteString -> IO ()
bindBlob statement parameterIndex byteString = do
error <- bindBlobError statement parameterIndex byteString
case error of
ErrorOK -> return ()
_ -> sqlError Nothing "bind blob" error
foreign import ccall "sqlite3_bind_double"
bindDoubleC :: Ptr () -> Int -> Double -> IO Int
bindDoubleError :: Statement -> Int -> Double -> IO Error
bindDoubleError (Statement statement) parameterIndex datum = do
error <- bindDoubleC statement parameterIndex datum
return $ decodeError error
bindDouble :: Statement -> Int -> Double -> IO ()
bindDouble statement parameterIndex datum = do
error <- bindDoubleError statement parameterIndex datum
case error of
ErrorOK -> return ()
_ -> sqlError Nothing "bind double" error
foreign import ccall "sqlite3_bind_int"
bindIntC :: Ptr () -> Int -> Int -> IO Int
bindIntError :: Statement -> Int -> Int -> IO Error
bindIntError (Statement statement) parameterIndex datum = do
error <- bindIntC statement parameterIndex datum
return $ decodeError error
bindInt :: Statement -> Int -> Int -> IO ()
bindInt statement parameterIndex datum = do
error <- bindIntError statement parameterIndex datum
case error of
ErrorOK -> return ()
_ -> sqlError Nothing "bind int" error
foreign import ccall "sqlite3_bind_int64"
bindInt64C :: Ptr () -> Int -> Int64 -> IO Int
bindInt64Error :: Statement -> Int -> Int64 -> IO Error
bindInt64Error (Statement statement) parameterIndex datum = do
error <- bindInt64C statement parameterIndex datum
return $ decodeError error
bindInt64 :: Statement -> Int -> Int64 -> IO ()
bindInt64 statement parameterIndex datum = do
error <- bindInt64Error statement parameterIndex datum
case error of
ErrorOK -> return ()
_ -> sqlError Nothing "bind int64" error
foreign import ccall "sqlite3_bind_null"
bindNullC :: Ptr () -> Int -> IO Int
bindNullError :: Statement -> Int -> IO Error
bindNullError (Statement statement) parameterIndex = do
error <- bindNullC statement parameterIndex
return $ decodeError error
bindNull :: Statement -> Int -> IO ()
bindNull statement parameterIndex = do
error <- bindNullError statement parameterIndex
case error of
ErrorOK -> return ()
_ -> sqlError Nothing "bind null" error
foreign import ccall "sqlite3_bind_text"
bindTextC :: Ptr () -> Int -> CString -> Int -> Ptr () -> IO Int
bindTextError :: Statement -> Int -> Text -> IO Error
bindTextError (Statement statement) parameterIndex text = do
let byteString = encodeUtf8 text
size <- return $ BS.length byteString
BS.useAsCString byteString
(\dataC -> do
error <- bindTextC statement parameterIndex dataC size
(intPtrToPtr (-1))
return $ decodeError error)
bindText :: Statement -> Int -> Text -> IO ()
bindText statement parameterIndex text = do
error <- bindTextError statement parameterIndex text
case error of
ErrorOK -> return ()
_ -> sqlError Nothing "bind text" error
bind :: Statement -> [PersistValue] -> IO ()
bind statement sqlData = do
mapM_ (\(parameterIndex, datum) -> do
case datum of
PersistInt64 int64 -> bindInt64 statement parameterIndex int64
PersistDouble double -> bindDouble statement parameterIndex double
PersistRational rational -> bindText statement parameterIndex $ pack $ show (fromRational rational :: Pico)
PersistBool b -> bindInt64 statement parameterIndex $
if b then 1 else 0
PersistText text -> bindText statement parameterIndex text
PersistByteString blob -> bindBlob statement parameterIndex blob
PersistNull -> bindNull statement parameterIndex
PersistDay d -> bindText statement parameterIndex $ pack $ show d
PersistTimeOfDay d -> bindText statement parameterIndex $ pack $ show d
PersistUTCTime d -> bindText statement parameterIndex $ pack $ show d
PersistZonedTime (ZT d) -> bindText statement parameterIndex $ pack $ show d
PersistList l -> bindText statement parameterIndex $ listToJSON l
PersistMap m -> bindText statement parameterIndex $ mapToJSON m
PersistDbSpecific s -> bindText statement parameterIndex $ decodeUtf8With lenientDecode s
PersistObjectId _ -> P.error "Refusing to serialize a PersistObjectId to a SQLite value"
)
$ zip [1..] sqlData
return ()
foreign import ccall "sqlite3_column_type"
columnTypeC :: Ptr () -> Int -> IO Int
columnType :: Statement -> Int -> IO ColumnType
columnType (Statement statement) columnIndex = do
result <- columnTypeC statement columnIndex
return $ decodeColumnType result
foreign import ccall "sqlite3_column_bytes"
columnBytesC :: Ptr () -> Int -> IO Int
foreign import ccall "sqlite3_column_blob"
columnBlobC :: Ptr () -> Int -> IO (Ptr ())
columnBlob :: Statement -> Int -> IO BS.ByteString
columnBlob (Statement statement) columnIndex = do
size <- columnBytesC statement columnIndex
BSI.create size (\resultPtr -> do
dataPtr <- columnBlobC statement columnIndex
if dataPtr /= nullPtr
then BSI.memcpy resultPtr (castPtr dataPtr) (fromIntegral size)
else return ())
foreign import ccall "sqlite3_column_int64"
columnInt64C :: Ptr () -> Int -> IO Int64
columnInt64 :: Statement -> Int -> IO Int64
columnInt64 (Statement statement) columnIndex = do
columnInt64C statement columnIndex
foreign import ccall "sqlite3_column_double"
columnDoubleC :: Ptr () -> Int -> IO Double
columnDouble :: Statement -> Int -> IO Double
columnDouble (Statement statement) columnIndex = do
columnDoubleC statement columnIndex
foreign import ccall "sqlite3_column_text"
columnTextC :: Ptr () -> Int -> IO CString
columnText :: Statement -> Int -> IO Text
columnText (Statement statement) columnIndex = do
text <- columnTextC statement columnIndex
byteString <- BS.packCString text
return $ decodeUtf8With lenientDecode byteString
foreign import ccall "sqlite3_column_count"
columnCountC :: Ptr () -> IO Int
columnCount :: Statement -> IO Int
columnCount (Statement statement) = do
columnCountC statement
column :: Statement -> Int -> IO PersistValue
column statement columnIndex = do
theType <- columnType statement columnIndex
case theType of
IntegerColumn -> do
int64 <- columnInt64 statement columnIndex
return $ PersistInt64 int64
FloatColumn -> do
double <- columnDouble statement columnIndex
return $ PersistDouble double
TextColumn -> do
text <- columnText statement columnIndex
return $ PersistText text
BlobColumn -> do
byteString <- columnBlob statement columnIndex
return $ PersistByteString byteString
NullColumn -> return PersistNull
columns :: Statement -> IO [PersistValue]
columns statement = do
count <- columnCount statement
mapM (\i -> column statement i) [0..count-1]
foreign import ccall "sqlite3_changes"
changesC :: Connection' -> IO Int
changes :: Connection -> IO Int64
changes (Connection _ c) = fmap fromIntegral $ changesC c
|