X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=src%2FMain.hs;h=e7f9e9c6213ae8df2b65214d4ff46b69e9b294f5;hb=e88453d996ef8c94d581122309669c5c2aa87c9d;hp=7932bf353f014d83b86eb83f7600d779dd2539f7;hpb=da0885d061b23f99a6c9d24b6b823c4654893d9c;p=dead%2Fhtsn-import.git diff --git a/src/Main.hs b/src/Main.hs index 7932bf3..e7f9e9c 100644 --- a/src/Main.hs +++ b/src/Main.hs @@ -1,9 +1,10 @@ -{-# LANGUAGE NoMonomorphismRestriction #-} {-# LANGUAGE DoAndIfThenElse #-} +{-# LANGUAGE NoMonomorphismRestriction #-} module Main where -import Control.Arrow ( (&&&), arr, returnA ) +-- System imports. +import Control.Arrow ( (&&&), (>>^), arr, returnA ) import Control.Concurrent ( threadDelay ) import Control.Exception ( SomeException, catch ) import Control.Monad ( when ) @@ -28,8 +29,10 @@ import Text.XML.HXT.Core ( getText, hasName, readDocument, - runX ) + runX, + unpickleDoc ) +-- Local imports. import Backend ( Backend(..) ) import CommandLine ( get_args ) import Configuration ( Configuration(..), merge_optional ) @@ -42,40 +45,100 @@ import Network.Services.TSN.Report ( report_info, report_error ) import TSN.DbImport ( DbImport(..), ImportResult(..) ) -import qualified TSN.XML.Heartbeat as Heartbeat ( verify ) -import qualified TSN.XML.Injuries as Injuries ( Listing ) -import qualified TSN.XML.InjuriesDetail as InjuriesDetail ( PlayerListing ) -import qualified TSN.XML.News as News ( Message ) -import Xml ( parse_opts ) +import TSN.Parse ( format_parse_error ) +import qualified TSN.XML.AutoRacingDriverList as AutoRacingDriverList ( + dtd, + pickle_message ) +import qualified TSN.XML.AutoRacingResults as AutoRacingResults ( + dtd, + pickle_message ) +import qualified TSN.XML.AutoRacingSchedule as AutoRacingSchedule ( + dtd, + pickle_message ) +import qualified TSN.XML.EarlyLine as EarlyLine ( + dtd, + pickle_message ) +import qualified TSN.XML.GameInfo as GameInfo ( dtds, parse_xml ) +import qualified TSN.XML.Heartbeat as Heartbeat ( dtd, verify ) +import qualified TSN.XML.Injuries as Injuries ( dtd, pickle_message ) +import qualified TSN.XML.InjuriesDetail as InjuriesDetail ( + dtd, + pickle_message ) +import qualified TSN.XML.MLBEarlyLine as MLBEarlyLine ( + dtd, + pickle_message ) +import qualified TSN.XML.JFile as JFile ( dtd, pickle_message ) +import qualified TSN.XML.News as News ( + dtd, + has_only_single_sms, + pickle_message ) +import qualified TSN.XML.Odds as Odds ( dtd, pickle_message ) +import qualified TSN.XML.ScheduleChanges as ScheduleChanges ( + dtd, + pickle_message ) +import qualified TSN.XML.Scores as Scores ( dtd, pickle_message ) +import qualified TSN.XML.SportInfo as SportInfo ( dtds, parse_xml ) +import qualified TSN.XML.Weather as Weather ( + dtd, + is_type1, + pickle_message, + teams_are_normal ) +import Xml ( DtdName(..), parse_opts ) + +-- | This is where most of the work happens. This function is called +-- on every file that we would like to import. It determines which +-- importer to use based on the DTD, attempts to process the file, +-- and then returns whether or not it was successful. If the file +-- was processed, 'True' is returned. Otherwise, 'False' is +-- returned. +-- +-- The implementation is straightforward with one exception: since +-- we are already in arrow world with HXT, the @import_with_dtd@ +-- function is lifted to an 'Arrow' as well with 'arr'. This +-- prevents us from having to do a bunch of unwrapping and +-- rewrapping with the associated error checking. +-- +import_file :: Configuration -- ^ A configuration object needed for the + -- 'backend' and 'connection_string'. + -> FilePath -- ^ The path of the XML file to import. -import_file :: Configuration -> FilePath -> IO Bool + -> IO Bool -- ^ True if we processed the file, False otherwise. import_file cfg path = do results <- parse_and_import `catch` exception_handler case results of - -- If results' is empty, one of the arrows return "nothing." [] -> do + -- One of the arrows returned "nothing." report_error $ "Unable to determine DTD for file " ++ path ++ "." return False - (Err errmsg:_) -> do - report_error errmsg + (ImportFailed errmsg:_) -> do + report_error $ errmsg ++ " (" ++ path ++ ")" return False - (Info infomsg:_) -> do + (ImportSkipped infomsg:_) -> do + -- We processed the message but didn't import anything. Return + -- "success" so that the XML file is deleted. report_info infomsg return True - (Succ count:_) -> do - report_info $ "Successfully imported " ++ (show count) ++ - " records from " ++ path ++ "." + (ImportSucceeded:_) -> do + report_info $ "Successfully imported " ++ path ++ "." + return True + (ImportUnsupported infomsg:_) -> do + -- For now we return "success" for these too, since we know we don't + -- support a bunch of DTDs and we want them to get deleted. + report_info infomsg return True where + -- | This will catch *any* exception, even the ones thrown by + -- Haskell's 'error' (which should never occur under normal + -- circumstances). exception_handler :: SomeException -> IO [ImportResult] exception_handler e = do report_error (show e) let errdesc = "Failed to import file " ++ path ++ "." -- Return a nonempty list so we don't claim incorrectly that -- we couldn't parse the DTD. - return [Err errdesc] + return [ImportFailed errdesc] -- | An arrow that reads a document into an 'XmlTree'. readA :: IOStateArrow s a XmlTree @@ -83,8 +146,8 @@ import_file cfg path = do -- | An arrow which parses the doctype "SYSTEM" of an 'XmlTree'. -- We use these to determine the parser to use. - doctypeA :: ArrowXml a => a XmlTree String - doctypeA = getAttrl >>> hasName "doctype-SYSTEM" /> getText + dtdnameA :: ArrowXml a => a XmlTree DtdName + dtdnameA = getAttrl >>> hasName "doctype-SYSTEM" /> getText >>^ DtdName -- | Combine the arrows above as well as the function below -- (arrowized with 'arr') into an IO action that does everything @@ -95,41 +158,130 @@ import_file cfg path = do -- big one outside of the list. parse_and_import :: IO [ImportResult] parse_and_import = - runX (readA >>> (doctypeA &&& returnA) >>> (arr import_with_dtd)) + runX (readA >>> (dtdnameA &&& returnA) >>> (arr import_with_dtd)) >>= sequence - -- | Takes a 'Doctype', 'XmlTree' pair and uses the 'Doctype' to - -- determine which function to call on the 'XmlTree'. - import_with_dtd :: (String, XmlTree) -> IO ImportResult - import_with_dtd (dtd,xml) - | dtd == "Heartbeat.dtd" = Heartbeat.verify xml + -- | Takes a ('DtdName', 'XmlTree') pair and uses the 'DtdName' + -- to determine which function to call on the 'XmlTree'. + import_with_dtd :: (DtdName, XmlTree) -> IO ImportResult + import_with_dtd (DtdName dtd,xml) + -- We special-case the heartbeat so it doesn't have to run in + -- the database monad. + | dtd == Heartbeat.dtd = Heartbeat.verify xml | otherwise = -- We need NoMonomorphismRestriction here. if backend cfg == Postgres - then withPostgresqlConn cs $ runDbConn $ importer xml - else withSqliteConn cs $ runDbConn $ importer xml + then withPostgresqlConn cs $ runDbConn importer + else withSqliteConn cs $ runDbConn importer where -- | Pull the real connection String out of the configuration. + -- cs :: String cs = get_connection_string $ connection_string cfg + -- | Convenience; we use this everywhere below in 'importer'. + -- + migrate_and_import m = dbmigrate m >> dbimport m + + -- | The error message we return if unpickling fails. + -- + errmsg = "Could not unpickle " ++ dtd ++ "." + + -- | Try to migrate and import using the given pickler @f@; + -- if it works, return the result. Otherwise, return an + -- 'ImportFailed' along with our error message. + -- + go f = maybe + (return $ ImportFailed errmsg) + migrate_and_import + (unpickleDoc f xml) + importer - | dtd == "injuriesxml.dtd" = - dbimport (undefined :: Injuries.Listing) + | dtd == AutoRacingDriverList.dtd = + go AutoRacingDriverList.pickle_message + + | dtd == AutoRacingResults.dtd = + go AutoRacingResults.pickle_message + + | dtd == AutoRacingSchedule.dtd = + go AutoRacingSchedule.pickle_message + + | dtd == EarlyLine.dtd = + go EarlyLine.pickle_message - | dtd == "Injuries_Detail_XML.dtd" = - dbimport (undefined :: InjuriesDetail.PlayerListing) + -- GameInfo and SportInfo appear last in the guards + | dtd == Injuries.dtd = go Injuries.pickle_message - | dtd == "newsxml.dtd" = - dbimport (undefined :: News.Message) + | dtd == InjuriesDetail.dtd = go InjuriesDetail.pickle_message - | otherwise = \_ -> do -- Dummy arg simplifies the other cases. + | dtd == JFile.dtd = go JFile.pickle_message + + | dtd == MLBEarlyLine.dtd = + go MLBEarlyLine.pickle_message + + | dtd == News.dtd = + -- Some of the newsxml docs are busted in predictable ways. + -- We want them to "succeed" so that they're deleted. + -- We already know we can't parse them. + if News.has_only_single_sms xml + then go News.pickle_message + else do + let msg = "Unsupported newsxml.dtd with multiple SMS " ++ + "(" ++ path ++ ")" + return $ ImportUnsupported msg + | dtd == Odds.dtd = go Odds.pickle_message + + | dtd == ScheduleChanges.dtd = go ScheduleChanges.pickle_message + + | dtd == Scores.dtd = go Scores.pickle_message + + -- SportInfo and GameInfo appear last in the guards + | dtd == Weather.dtd = + -- Some of the weatherxml docs are busted in predictable ways. + -- We want them to "succeed" so that they're deleted. + -- We already know we can't parse them. + if Weather.is_type1 xml + then if Weather.teams_are_normal xml + then go Weather.pickle_message + else do + let msg = "Teams in reverse order in weatherxml.dtd" ++ + " (" ++ path ++ ")" + return $ ImportUnsupported msg + else do + let msg = "Unsupported weatherxml.dtd type (" ++ path ++ ")" + return $ ImportUnsupported msg + + | dtd `elem` GameInfo.dtds = do + let either_m = GameInfo.parse_xml dtd xml + case either_m of + -- This might give us a slightly better error + -- message than the default 'errmsg'. + Left err -> return $ ImportFailed (format_parse_error err) + Right m -> migrate_and_import m + + | dtd `elem` SportInfo.dtds = do + let either_m = SportInfo.parse_xml dtd xml + case either_m of + -- This might give us a slightly better error + -- message than the default 'errmsg'. + Left err -> return $ ImportFailed (format_parse_error err) + Right m -> migrate_and_import m + + | otherwise = do let infomsg = "Unrecognized DTD in " ++ path ++ ": " ++ dtd ++ "." - return $ Info infomsg + return $ ImportUnsupported infomsg + +-- | Entry point of the program. It twiddles some knobs for +-- configuration options and then calls 'import_file' on each XML +-- file given on the command-line. +-- +-- Any file successfully processed is then optionally removed, and +-- we're done. +-- main :: IO () main = do rc_cfg <- OC.from_rc @@ -144,7 +296,7 @@ main = do -- logging before the missing parameter checks below so that we can -- log the errors. let cfg = (def :: Configuration) `merge_optional` opt_config - init_logging (log_file cfg) (log_level cfg) (syslog cfg) + init_logging (log_level cfg) (log_file cfg) (syslog cfg) -- Check the optional config for missing required options. when (null $ OC.xml_files opt_config) $ do @@ -158,13 +310,22 @@ main = do -- Zip the results with the files list to find out which ones can be -- deleted. let result_pairs = zip (OC.xml_files opt_config) results - let victims = filter (\(_,result) -> result) result_pairs - mapM_ ((kill True) . fst) victims + let victims = [ p | (p, True) <- result_pairs ] + let processed_count = length victims + report_info $ "Processed " ++ (show processed_count) ++ " document(s) total." + when (remove cfg) $ mapM_ (kill True) victims where - kill try_again path = do - removeFile path `catchIOError` exception_handler - report_info $ "Removed imported file " ++ path ++ "." + -- | Wrap these two actions into one function so that we don't + -- report that the file was removed if the exception handler is + -- run. + remove_and_report path = do + removeFile path + report_info $ "Removed processed file " ++ path ++ "." + + -- | Try to remove @path@ and potentially try again. + kill try_again path = + (remove_and_report path) `catchIOError` exception_handler where -- | A wrapper around threadDelay which takes seconds instead of -- microseconds as its argument. @@ -173,12 +334,14 @@ main = do let microseconds = seconds * (10 ^ (6 :: Int)) threadDelay microseconds + -- | If we can't remove the file, report that, and try once + -- more after waiting a few seconds. exception_handler :: IOError -> IO () exception_handler e = do report_error (show e) report_error $ "Failed to remove imported file " ++ path ++ "." if try_again then do - report_info $ "Waiting 5 seconds to attempt removal again..." + report_info "Waiting 5 seconds to attempt removal again..." thread_sleep 5 kill False path else