]> gitweb.michael.orlitzky.com - dead/htsn-import.git/commitdiff
Provide a default connection string (for sqlite).
authorMichael Orlitzky <michael@orlitzky.com>
Sun, 29 Dec 2013 23:55:30 +0000 (18:55 -0500)
committerMichael Orlitzky <michael@orlitzky.com>
Sun, 29 Dec 2013 23:55:30 +0000 (18:55 -0500)
Implement the backend choice; you can now really choose your database.

htsn-import.cabal
src/Backend.hs
src/Configuration.hs
src/ConnectionString.hs [new file with mode: 0644]
src/ExitCodes.hs
src/Main.hs
src/OptionalConfiguration.hs

index 8c651a90e17aa44f6013d9c0658f367b59eb95bb..8e5a9d34c722f33929f23812159bb97a1079f58b 100644 (file)
@@ -24,6 +24,7 @@ executable htsn-import
     htsn-common                 == 0.0.1,
     hxt                         == 9.3.*,
     groundhog                   == 0.4.*,
+    groundhog-postgresql        == 0.4.*,
     groundhog-sqlite            == 0.4.*,
     groundhog-th                == 0.4.*,
     old-locale                  == 1.0.*,
index 04cf6ca3854891a8d9a9947567f2bf88d8ee7b79..0de431e60ce29aa6a223ce9916110c6b596c6cee 100644 (file)
@@ -10,7 +10,7 @@ import System.Console.CmdArgs.Default ( Default(..) )
 
 -- | An enumeration type for the allowed database backends.
 data Backend = Sqlite | Postgres
-               deriving (Data, Read, Show, Typeable)
+               deriving (Data, Eq, Read, Show, Typeable)
 
 instance Default Backend where
   def = Sqlite
index d56cc936e6fc6983ae94ea78cc57885de27cbe54..168136a58ad6adb25bc72df12404d98e52acc7fc 100644 (file)
@@ -11,6 +11,7 @@ import System.Console.CmdArgs.Default ( Default(..) )
 import System.Log ( Priority( INFO ) )
 
 import Backend ( Backend(..) )
+import ConnectionString ( ConnectionString )
 import qualified OptionalConfiguration as OC (
   OptionalConfiguration(..),
   merge_maybes )
@@ -20,7 +21,7 @@ import qualified OptionalConfiguration as OC (
 data Configuration =
   Configuration {
     backend           :: Backend,
-    connection_string :: String,
+    connection_string :: ConnectionString,
     log_file          :: Maybe FilePath,
     log_level         :: Priority,
     syslog            :: Bool }
diff --git a/src/ConnectionString.hs b/src/ConnectionString.hs
new file mode 100644 (file)
index 0000000..26f81d6
--- /dev/null
@@ -0,0 +1,46 @@
+{-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE OverloadedStrings #-}
+
+-- | Definition of and instances for the ConnectionString type.
+--
+module ConnectionString (
+  ConnectionString(..) )
+where
+
+-- DC is needed only for the DCT.Configured instance of String.
+import qualified Data.Configurator as DC()
+import qualified Data.Configurator.Types as DCT (
+  Configured,
+  Value( String ),
+  convert )
+import Data.Data (Data)
+import System.Console.CmdArgs.Default (Default(..))
+import Data.Typeable (Typeable)
+
+-- | A newtype around a string that allows us to give a more
+--   appropriate default value for a connection string.
+--
+newtype ConnectionString =
+  ConnectionString { get_connection_string :: String }
+  deriving (Data, Show, Typeable)
+
+instance Default ConnectionString where
+  -- | This default is appropriate for SQLite databases which require
+  --   no authentication and live entirely in a file (or in this case,
+  --   memory).
+  def = ConnectionString ":memory:"
+
+
+instance DCT.Configured ConnectionString where
+  -- | This allows us to read a ConnectionString out of a Configurator
+  --   config file. By default Configurator wouldn't know what to do,
+  --   so we have to tell it that we expect a DCT.String, and if one
+  --   exists, to apply the ConnectionString constructor to it.
+  convert s@(DCT.String _) =
+    fmap ConnectionString (convert_string s)
+    where
+      convert_string :: DCT.Value -> Maybe String
+      convert_string = DCT.convert
+
+  -- If we read anything other than a DCT.String out of the file, fail.
+  convert _ = Nothing
index 7371e86326ff3b66eabd52c4c654bd7508df5189..acb725274a993fe7c882bc5dda329c8e0c084f8b 100644 (file)
@@ -2,16 +2,10 @@
 --   ExitSuccess).
 --
 module ExitCodes (
-  exit_no_connection_string,
   exit_no_xml_files )
 where
 
--- | No connection string was given on the command line or in the
---   config file.
-exit_no_connection_string :: Int
-exit_no_connection_string = 1
-
 -- | No XML files were given on the command line.
 exit_no_xml_files :: Int
-exit_no_xml_files = 2
+exit_no_xml_files = 1
 
index e94d21b4fa7e264d39469daec8ad730a8838895f..e1f40267889c9e4a8a4609cb0a7e7bf9c3b47b95 100644 (file)
@@ -1,18 +1,21 @@
+{-# LANGUAGE NoMonomorphismRestriction #-}
 module Main
 where
 
 import Control.Arrow ( (&&&), arr, returnA )
 import Control.Monad ( when )
 import Control.Monad.IO.Class ( liftIO )
-import Database.Groundhog.Core ( PersistEntity )
-import Database.Groundhog.Sqlite (
+import Database.Groundhog (
   defaultMigrationLogger,
   insert,
   migrate,
-  runDbConn,
-  runMigration,
+  runMigration )
+import Database.Groundhog.Core ( PersistEntity )
+import Database.Groundhog.Generic ( runDbConn )
+import Database.Groundhog.Sqlite (
   withSqliteConn )
-import Data.Maybe ( isNothing )
+import Database.Groundhog.Postgresql (
+  withPostgresqlConn )
 import Data.Monoid ( (<>) )
 import System.Console.CmdArgs ( def )
 import System.Exit ( exitWith, ExitCode (ExitFailure) )
@@ -39,14 +42,14 @@ import Text.XML.HXT.Core (
   xpickle,
   yes )
 
+import Backend ( Backend(..) )
 import CommandLine ( get_args )
 import Configuration ( Configuration(..), merge_optional )
-import ExitCodes (
-  exit_no_connection_string,
-  exit_no_xml_files )
+import ConnectionString ( ConnectionString(..) )
+import ExitCodes ( exit_no_xml_files )
 import Network.Services.TSN.Logging ( init_logging )
 import qualified OptionalConfiguration as OC (
-  OptionalConfiguration ( connection_string, xml_files ),
+  OptionalConfiguration ( xml_files ),
   from_rc )
 import Network.Services.TSN.Report (
   report_info,
@@ -76,44 +79,56 @@ parse_opts =
     withValidate no ]
 
 
--- | We put the 'XmlTree' argument last so that it's easy to eta
---   reduce all of the import_foo functions that call this.
+-- | We put the 'Configuration' and 'XmlTree' arguments last so that
+-- it's easy to eta reduce all of the import_foo functions that call
+-- this.
 --
 import_generic :: (XmlPickler a, PersistEntity b)
                => b          -- ^ Dummy Listing instance needed for 'migrate'
                -> (a -> [b]) -- ^ listings getter
+               -> Configuration
                -> XmlTree
                -> IO (Maybe Int) -- ^ Return the number of records inserted.
-import_generic dummy g xml =
-  withSqliteConn "foo.sqlite3" $ runDbConn $ do
-    runMigration defaultMigrationLogger $ do
-      migrate dummy
-    let root_element = unpickleDoc xpickle xml
-    case root_element of
-      Nothing -> do
-        let msg = "Could not unpickle document in import_generic."
-        liftIO $ report_error msg
-        return Nothing
-      Just elt  -> do
-        ids <- mapM (\l -> insert l) (g elt)
-        return $ Just (length ids)
+import_generic dummy g cfg xml
+  | backend cfg == Postgres = withPostgresqlConn cs go
+  | otherwise               = withSqliteConn cs go
+  where
+    -- | Pull the real connection String out  of the configuration.
+    cs :: String
+    cs = get_connection_string $ connection_string cfg
+
+    -- Needs NoMonomorphismRestriction to be allowed to return
+    -- different types in the two cases above.
+    go = runDbConn $ do
+      runMigration defaultMigrationLogger $ migrate dummy
+      let root_element = unpickleDoc xpickle xml
+      case root_element of
+        Nothing -> do
+          let msg = "Could not unpickle document in import_generic."
+          liftIO $ report_error msg
+          return Nothing
+        Just elt  -> do
+          ids <- mapM insert (g elt)
+          return $ Just (length ids)
+
+
 
 -- | Import TSN.Injuries from an 'XmlTree'.
-import_injuries :: XmlTree -> IO (Maybe Int)
+import_injuries :: Configuration -> XmlTree -> IO (Maybe Int)
 import_injuries =
   import_generic
     (undefined :: Injuries.Listing)
     Injuries.listings
 
 -- | Import TSN.InjuriesDetail from an 'XmlTree'.
-import_injuries_detail :: XmlTree -> IO (Maybe Int)
+import_injuries_detail :: Configuration -> XmlTree -> IO (Maybe Int)
 import_injuries_detail =
   import_generic
     (undefined :: InjuriesDetail.PlayerListing)
     ( (concatMap InjuriesDetail.player_listings) . InjuriesDetail.listings)
 
-import_file :: FilePath -> IO ()
-import_file path = do
+import_file :: Configuration -> FilePath -> IO ()
+import_file cfg path = do
   results <- catchIOError
                parse_and_import
                (\e -> do
@@ -151,7 +166,7 @@ import_file path = do
     --   big one outside of the list.
     parse_and_import :: IO [Maybe Int]
     parse_and_import =
-      (runX $ readA >>> (doctypeA &&& returnA) >>> (arr import_with_dtd))
+      runX (readA >>> (doctypeA &&& returnA) >>> (arr import_with_dtd))
       >>=
       sequence
 
@@ -159,8 +174,8 @@ import_file path = do
     --   determine which function to call on the 'XmlTree'.
     import_with_dtd :: (String, XmlTree) -> IO (Maybe Int)
     import_with_dtd (dtd,xml)
-      | dtd == "injuriesxml.dtd" = import_injuries xml
-      | dtd == "Injuries_Detail_XML.dtd" = import_injuries_detail xml
+      | dtd == "injuriesxml.dtd" = import_injuries cfg xml
+      | dtd == "Injuries_Detail_XML.dtd" = import_injuries_detail cfg xml
       | otherwise = do
           report_info $ "Unrecognized DTD in " ++ path ++ ": " ++ dtd ++ "."
           return Nothing
@@ -186,13 +201,6 @@ main = do
     report_error "No XML files given."
     exitWith (ExitFailure exit_no_xml_files)
 
-  -- There's a default connection string, namely the empty string, but
-  -- it's not much use to us. So we make sure that we were given
-  -- something explicitly.
-  when (isNothing (OC.connection_string opt_config)) $ do
-    report_error "No connection string supplied."
-    exitWith (ExitFailure exit_no_connection_string)
-
   -- We don't do this in parallel (for now?) to keep the error
   -- messages nice and linear.
-  mapM_ import_file (OC.xml_files opt_config)
+  mapM_ (import_file cfg) (OC.xml_files opt_config)
index ce99f5f9517beeb2e4907da77e7a32ea00cdd378..9013112f997ebcc5f389d1099c75edea1f67aa5c 100644 (file)
@@ -34,6 +34,7 @@ import System.Log ( Priority(..) )
 import Text.Read ( readMaybe )
 
 import Backend ( Backend(..) )
+import ConnectionString ( ConnectionString )
 import Network.Services.TSN.Report ( report_error )
 
 
@@ -51,7 +52,7 @@ deriving instance Typeable Priority
 data OptionalConfiguration =
   OptionalConfiguration {
     backend           :: Maybe Backend,
-    connection_string :: Maybe String,
+    connection_string :: Maybe ConnectionString,
     log_file          :: Maybe FilePath,
     log_level         :: Maybe Priority,
     syslog            :: Maybe Bool,