X-Git-Url: http://gitweb.michael.orlitzky.com/?p=dead%2Fhtsn.git;a=blobdiff_plain;f=src%2FMain.hs;fp=src%2FMain.hs;h=dcb38b23e338eb3bc93524aec2d84173b4dd51d0;hp=38dd2e5ad5e8af5c4336c667507a6a87b74c0ccd;hb=60aea8c7765bf2382b1d24d039f3951e00434e3c;hpb=4833dc57c60f4aeaa160ec5e599507653a47809b diff --git a/src/Main.hs b/src/Main.hs index 38dd2e5..dcb38b2 100644 --- a/src/Main.hs +++ b/src/Main.hs @@ -4,6 +4,7 @@ module Main where +-- System imports. import Control.Concurrent ( threadDelay ) import Control.Exception ( bracket, throw ) import Control.Monad ( when ) @@ -13,6 +14,13 @@ import Data.Monoid ( (<>) ) import Network ( connectTo, PortID (PortNumber) ) +import Network.Services.TSN.Logging ( init_logging ) +import Network.Services.TSN.Report ( + report_debug, + report_info, + report_warning, + report_error ) +import Network.Services.TSN.Terminal ( display_sent ) import System.Console.CmdArgs ( def ) import System.Directory ( doesFileExist ) import System.Exit ( ExitCode(..), exitWith ) @@ -30,6 +38,7 @@ import System.IO ( import System.IO.Error ( catchIOError ) import System.Timeout ( timeout ) +-- Local imports. import CommandLine ( get_args ) import Configuration ( Configuration(..), merge_optional ) import ExitCodes ( @@ -38,22 +47,15 @@ import ExitCodes ( exit_no_username, exit_pidfile_exists ) import FeedHosts ( FeedHosts(..) ) -import Network.Services.TSN.Logging ( init_logging ) import qualified OptionalConfiguration as OC ( OptionalConfiguration(..), from_rc ) -import Network.Services.TSN.Report ( - report_debug, - report_info, - report_warning, - report_error ) -import Network.Services.TSN.Terminal ( display_sent ) import Xml ( parse_xmlfid ) import Unix ( full_daemonize ) --- | Receive a single line of text from a Handle, and send it to the --- debug log. +-- | Receive a single line of text from a 'Handle', and record it for +-- debugging purposes. -- recv_line :: Handle -> IO String recv_line h = do @@ -62,14 +64,16 @@ recv_line h = do return line --- | Takes a Configuration, and an XML document (as a String). The XML --- document is written to the output directory, as specified by the --- Configuration. +-- | Takes a 'Configuration', and an XML document (as a 'String'). The +-- XML document is written to the output directory, as specified by +-- the 'Configuration'. -- -- This can fail, but we don't purposefully throw any exceptions. If -- something goes wrong, we would rather log it and keep going. -- -save_document :: Configuration -> String -> IO () +save_document :: Configuration + -> String -- ^ String representation of an XML document + -> IO () save_document cfg doc = case either_path of Left err -> report_error err @@ -87,9 +91,9 @@ save_document cfg doc = either_path = fmap ((output_directory cfg) ) filename --- | Loop forever, writing the buffer to file whenever a --- tag is seen. This is the low-level "loop forever" function that --- we stay in as long as we are connected to one feed. +-- | Loop forever, writing the @buffer@ to file whenever a +-- \ tag is seen. This is the low-level \"loop forever\" +-- function that we stay in as long as we are connected to one feed. -- -- The documentation at -- states @@ -98,7 +102,13 @@ save_document cfg doc = -- for a given document. We therefore rely on this to simplify -- processing. -- -loop :: Configuration -> Handle -> [String] -> IO () +-- The bang pattern at least on @buffer@ is necessary for +-- performance reasons. +-- +loop :: Configuration + -> Handle -- ^ Handle to the feed (network connection) + -> [String] -- ^ Current XML document buffer, line-by-line, in reverse + -> IO () loop !cfg !h !buffer = do line <- recv_line h let new_buffer = line : buffer @@ -124,9 +134,9 @@ loop !cfg !h !buffer = do -- (apparently) successfully guessed it. -- -- The first thing TSN sends once we've connected is the string --- "Username: ", containing 10 ASCII characters. We then send a +-- \"Username: \", containing 10 ASCII characters. We then send a -- username, followed by a newline. If TSN likes the username, the --- second they'll send is the string "Password: ", also containing +-- second they'll send is the string \"Password: \", also containing -- 10 ASCII characters, to which we reply in kind. -- -- Assuming the above will always hold, it is implemented as follows: @@ -139,8 +149,8 @@ loop !cfg !h !buffer = do -- -- 4. Send password if we got the password prompt -- --- If TSN likes the password as well, they send the string "The --- Sports Network" before finally beginning to stream the feed. +-- If TSN likes the password as well, they send the string \"The +-- Sports Network\" before finally beginning to stream the feed. -- log_in :: Configuration -> Handle -> IO () log_in cfg h = do @@ -188,13 +198,15 @@ log_in cfg h = do -- -- Steps: -- --- 1. Connect to the host on the XML port +-- 1. Connect to @host@ on the XML feed port. -- --- 2. Log in +-- 2. Log in. -- -- 3. Go into the eternal read/save loop. -- -connect_and_parse :: Configuration -> String -> IO () +connect_and_parse :: Configuration + -> String -- ^ Hostname to connect to + -> IO () connect_and_parse cfg host = do report_info $ "Connecting to " ++ host ++ "." bracket acquire_handle release_handle action @@ -234,7 +246,8 @@ connect_and_parse cfg host = do -- | A wrapper around threadDelay which takes seconds instead of -- microseconds as its argument. -- -thread_sleep :: Int -> IO () +thread_sleep :: Int -- ^ Number of seconds for which to sleep. + -> IO () thread_sleep seconds = do let microseconds = seconds * (10 ^ (6 :: Int)) threadDelay microseconds @@ -300,7 +313,7 @@ main = do else run_program where - -- | This is the top-level "loop forever" function. If an + -- | This is the top-level \"loop forever\" function. If an -- exception is thrown, it will propagate up to this point, where -- it will be logged and ignored in style. --