persistent-mysql-haskell 0.2.1.0 → 0.3.0.0

raw patch · 4 files changed

+70/−35 lines, 4 filesdep +tlsPVP ok

version bump matches the API change (PVP)

Dependencies added: tls

API changes (from Hackage documentation)

Files

• ChangeLog.md +4/−0
• Database/Persist/MySQL.hs +61/−31
• README.md +2/−2
• persistent-mysql-haskell.cabal +3/−2

@@ -1,3 +1,7 @@+## 0.3.0.0+- Added API for setting [TLS client parameters](https://hackage.haskell.org/package/mysql-haskell-0.8.0.0/docs/Database-MySQL-TLS.html) for secure MySQL connections.+- Exported [Data.TLSSetting](https://hackage.haskell.org/package/tcp-streams-1.0.0.0/docs/Data-TLSSetting.html) for convenient usage of TLS.+ ## 0.2.1.0 - Bumped up version to update README. 

@@ -17,6 +17,11 @@   , MySQLConf   , mkMySQLConf   , mockMigration+  -- * TLS configuration+  , setMySQLConnectInfoTLS+  , MySQLTLS.TrustedCAStore(..)+  , MySQLTLS.makeClientParams+  , MySQLTLS.makeClientParams' ) where  import Control.Arrow@@ -54,6 +59,8 @@ import Data.Int (Int64)  import qualified Database.MySQL.Base    as MySQL+import qualified Database.MySQL.TLS     as MySQLTLS+import qualified Network.TLS            as TLS import qualified System.IO.Streams      as Streams import qualified Data.Time.Calendar     as Time import qualified Data.Time.LocalTime    as Time@@ -101,12 +108,18 @@               -> m a withMySQLConn = withSqlConn . open' +-- | Internal function that opens a @mysql-haskell@ connection to the server.+connect' :: MySQLConnectInfo -> IO MySQL.MySQLConn+connect' (MySQLConnectInfo innerCi Nothing)+  = MySQL.connect innerCi+connect' (MySQLConnectInfo innerCi (Just tls))+  = MySQLTLS.connect innerCi (tls, "persistent-mysql-haskell") --- | Internal function that opens a connection to the MySQL+-- | Internal function that opens a @persistent@ connection to the MySQL -- server. open' :: (IsSqlBackend backend) => MySQLConnectInfo -> LogFunc -> IO backend-open' (MySQLConnectInfo ci) logFunc = do-    conn <- MySQL.connect ci+open' ci@(MySQLConnectInfo innerCi _) logFunc = do+    conn <- connect' ci     autocommit' conn False -- disable autocommit!     smap <- newIORef $ Map.empty     return . mkPersistBackend $ SqlBackend@@ -116,7 +129,7 @@         , connInsertManySql = Nothing         , connUpsertSql = Nothing         , connClose      = MySQL.close conn-        , connMigrateSql = migrate' ci+        , connMigrateSql = migrate' innerCi         , connBegin      = const $ begin' conn         , connCommit     = const $ commit' conn         , connRollback   = const $ rollback' conn@@ -880,7 +893,7 @@ -- using @persistent@'s generic facilities.  These values are the -- same that are given to 'withMySQLPool'. data MySQLConf = MySQLConf-    { myConnInfo :: MySQL.ConnectInfo+    { myConnInfo :: MySQLConnectInfo       -- ^ The connection information.     , myPoolSize :: Int       -- ^ How many connections should be held on the connection pool.@@ -891,38 +904,55 @@   :: MySQLConnectInfo  -- ^ The connection information.   -> Int               -- ^ How many connections should be held on the connection pool.   -> MySQLConf-mkMySQLConf (MySQLConnectInfo ci) = MySQLConf ci+mkMySQLConf = MySQLConf  -- | MySQL connection information.-newtype MySQLConnectInfo = MySQLConnectInfo MySQL.ConnectInfo-  deriving Show+data MySQLConnectInfo = MySQLConnectInfo+  { innerConnInfo :: MySQL.ConnectInfo+  , innerConnTLS  :: (Maybe TLS.ClientParams)+  } deriving Show  -- | Public constructor for @MySQLConnectInfo@. mkMySQLConnectInfo-  :: NetworkSocket.HostName -- ^ hostname+  :: NetworkSocket.HostName  -- ^ hostname   -> BSC.ByteString          -- ^ username   -> BSC.ByteString          -- ^ password   -> BSC.ByteString          -- ^ database   -> MySQLConnectInfo mkMySQLConnectInfo host user pass db-  = MySQLConnectInfo   $ MySQL.defaultConnectInfo {-      MySQL.ciHost     = host-    , MySQL.ciUser     = user-    , MySQL.ciPassword = pass-    , MySQL.ciDatabase = db-  }+  = MySQLConnectInfo innerCi Nothing+  where+    innerCi = MySQL.defaultConnectInfo {+        MySQL.ciHost     = host+      , MySQL.ciUser     = user+      , MySQL.ciPassword = pass+      , MySQL.ciDatabase = db+    }  -- | Update port number for @MySQLConnectInfo@.-setMySQLConnectInfoPort :: NetworkSocket.PortNumber -> MySQLConnectInfo -> MySQLConnectInfo-setMySQLConnectInfoPort port (MySQLConnectInfo ci) = MySQLConnectInfo $ ci { MySQL.ciPort = port }+setMySQLConnectInfoPort+  :: NetworkSocket.PortNumber -> MySQLConnectInfo -> MySQLConnectInfo+setMySQLConnectInfoPort port ci+  = ci {innerConnInfo = innerCi { MySQL.ciPort = port } }+  where innerCi = innerConnInfo ci  -- | Update character set for @MySQLConnectInfo@. setMySQLConnectInfoCharset   :: Word.Word8       -- ^ Numeric ID of collation. See https://dev.mysql.com/doc/refman/5.7/en/show-collation.html.   -> MySQLConnectInfo -- ^ Reference connectInfo to perform update on   -> MySQLConnectInfo-setMySQLConnectInfoCharset charset (MySQLConnectInfo ci) = MySQLConnectInfo $ ci { MySQL.ciCharset = charset }+setMySQLConnectInfoCharset charset ci+  = ci {innerConnInfo = innerCi { MySQL.ciCharset = charset } }+  where innerCi = innerConnInfo ci +-- | Set TLS ClientParams for @MySQLConnectInfo@.+setMySQLConnectInfoTLS+  :: TLS.ClientParams -- ^ @ClientParams@ to establish a TLS connection with.+  -> MySQLConnectInfo -- ^ Reference connectInfo to perform update on+  -> MySQLConnectInfo+setMySQLConnectInfoTLS tls ci+  = ci {innerConnTLS = Just tls}+ -- TODO: submit a PR to mysql-haskell to add SHOW instance deriving instance Show MySQL.ConnectInfo @@ -942,14 +972,15 @@                    , MySQL.ciPassword = BSC.pack password                    , MySQL.ciDatabase = BSC.pack database                    }-        return $ MySQLConf ci pool+        return $ MySQLConf (MySQLConnectInfo ci Nothing) pool  instance PersistConfig MySQLConf where     type PersistConfigBackend MySQLConf = SqlPersistT      type PersistConfigPool    MySQLConf = ConnectionPool -    createPoolConfig (MySQLConf cs size) = runNoLoggingT $ createMySQLPool (MySQLConnectInfo cs) size -- FIXME+    createPoolConfig (MySQLConf cs size)+      = runNoLoggingT $ createMySQLPool cs size -- FIXME      runPool _ = runSqlPool @@ -958,23 +989,22 @@     applyEnv conf = do         env <- getEnvironment         let maybeEnv old var = maybe old id $ fmap BSC.pack $ lookup ("MYSQL_" ++ var) env-        return conf-          { myConnInfo =-              case myConnInfo conf of+        let innerCi = innerConnInfo . myConnInfo $ conf+        let innerCiNew = case innerCi of                 MySQL.ConnectInfo                   { MySQL.ciHost     = host                   , MySQL.ciPort     = port                   , MySQL.ciUser     = user                   , MySQL.ciPassword = password                   , MySQL.ciDatabase = database-                  } -> (myConnInfo conf)-                         { MySQL.ciHost     = BSC.unpack $ maybeEnv (BSC.pack host) "HOST"-                         , MySQL.ciPort     = read (BSC.unpack $ maybeEnv (BSC.pack $ show port) "PORT")-                         , MySQL.ciUser     = maybeEnv user "USER"-                         , MySQL.ciPassword = maybeEnv password "PASSWORD"-                         , MySQL.ciDatabase = maybeEnv database "DATABASE"-                         }-          }+                  } -> (innerCi)+                        { MySQL.ciHost     = BSC.unpack $ maybeEnv (BSC.pack host) "HOST"+                        , MySQL.ciPort     = read (BSC.unpack $ maybeEnv (BSC.pack $ show port) "PORT")+                        , MySQL.ciUser     = maybeEnv user "USER"+                        , MySQL.ciPassword = maybeEnv password "PASSWORD"+                        , MySQL.ciDatabase = maybeEnv database "DATABASE"+                        }+        return conf { myConnInfo = MySQLConnectInfo innerCiNew Nothing }  mockMigrate :: MySQL.ConnectInfo          -> [EntityDef]

@@ -1,5 +1,7 @@ # persistent-mysql-haskell +![hackage version](https://img.shields.io/hackage/v/persistent-mysql-haskell.svg)+ A pure haskell backend for [persistent](https://github.com/yesodweb/persistent) using the MySQL database server. Internally it uses the [mysql-haskell](https://github.com/winterland1989/mysql-haskell) driver in order to access the database. @@ -66,8 +68,6 @@ #### persistent-mysql supports X but persistent-mysql-haskell API doesn't. Why?  - Internals (getters/setters) of MySQLConnectInfo and `defaultConnectInfo` are intentionally masked for [forward compatibility](http://www.snoyman.com/blog/2016/11/designing-apis-for-extensibility).--- `TLS` support is in the works.  - For all others, feel free to open an issue and/or submit a PR. 

@@ -1,5 +1,5 @@ name:            persistent-mysql-haskell-version:         0.2.1.0+version:         0.3.0.0 license:         MIT license-file:    LICENSE author:          Naushadh <naushadh@protonmail.com>, Felipe Lessa <felipe.lessa@gmail.com>, Michael Snoyman@@ -41,7 +41,8 @@                    , mysql-haskell         >= 0.8.0.0 && < 1.0                    , io-streams            >= 1.2     && < 2.0                    , time                  >= 1.5.0-                   , network               >= 2.3     && <3.0+                   , network               >= 2.3     && < 3.0+                   , tls                   >= 1.3.5   && < 1.4     exposed-modules: Database.Persist.MySQL     ghc-options:     -Wall