--- |The CommandLine module handles parsing of the command-line options.
--- It should more or less be a black box, providing Main with only the
--- information it requires.
-module CommandLine
-( heartbeat,
- help_set,
- help_text,
- from_email_address,
- to_email_address,
- parse_errors,
- parse_usernames
-) where
-
-import Data.Maybe (isJust, isNothing)
-import System.Console.GetOpt
-import System.Environment (getArgs)
-
-
-
--- |A record containing values for all available options.
-data Options = Options { opt_heartbeat :: Maybe Int,
- opt_help :: Bool,
- opt_from :: Maybe String,
- opt_to :: Maybe String }
-
-
--- |Constructs an instance of Options, with each of its members set to
--- default values.
-default_options :: Options
-default_options = Options { opt_heartbeat = Just 600,
- opt_help = False,
- opt_from = Nothing,
- opt_to = Nothing }
-
-
--- |The options list that we construct associates a function with each
--- option. This function is responsible for updating an Options record
--- with the appropriate value.
+module CommandLine (
+ get_args,
+ show_help )
+where
+
+import System.Console.CmdArgs (
+ (&=),
+ args,
+ cmdArgs,
+ def,
+ details,
+ groupname,
+ help,
+ helpArg,
+ program,
+ summary,
+ typ,
+ typFile,
+ versionArg )
+import System.Environment ( withArgs )
+
+-- Get the version from Cabal.
+import Paths_halcyon ( version )
+import Data.Version ( showVersion )
+
+import OptionalConfiguration ( OptionalCfg(..) )
+
+
+-- | The description of the program, displayed as part of the help.
--
--- For more information and an example of this idiom, see,
+description :: String
+description =
+ "Monitor a list of Twitter accounts and display or email any new tweets."
+
+
+-- | The name of this program.
+--
+program_name :: String
+program_name = "halcyon"
+
+
+-- | A summary string output as part of the help.
+--
+my_summary :: String
+my_summary = program_name ++ "-" ++ (showVersion version)
+
+
+-- | Help string for the \"access_secret\" option.
+--
+access_secret_help :: String
+access_secret_help = "Your Twitter API access secret"
+
+
+-- | Help string for the \"access_token\" option
+--
+access_token_help :: String
+access_token_help = "Your Twitter API access token"
+
+
+-- | Help string for the \"consumer_key\" option.
+--
+consumer_key_help :: String
+consumer_key_help = "Your Twitter API consumer key"
+
+
+-- | Help string for the \"consumer_secret\" option.
+--
+consumer_secret_help :: String
+consumer_secret_help = "Your Twitter API consumer secret"
+
+
+-- | A description of the \"daemonize\" option.
+--
+daemonize_help :: String
+daemonize_help = "Run as a daemon, in the background."
+
+
+-- | Help string for the \"from_address\" option.
+--
+from_address_help :: String
+from_address_help = "Send tweets from ADDRESS"
+
+
+-- | Help string for the \"heartbeat\" option.
+--
+heartbeat_help :: String
+heartbeat_help = "How many seconds to wait between polling"
+
+
+-- | Help string for the \"ignore_replies\" option.
--
--- <http://www.haskell.org/haskellwiki/High-level_option_handling_with_GetOpt>
+ignore_replies_help :: String
+ignore_replies_help = "Ignore replies to other tweets"
+
+
+-- | Help string for the \"ignore_retweets\" option.
--
-options :: [OptDescr (Options -> IO Options)]
-options =
- [ Option ['h'][] (NoArg set_help) "Prints this help message.",
- Option ['n'][] (ReqArg set_heartbeat "heartbeat") "How many seconds to wait between polling.",
- Option ['t'][] (ReqArg set_to "email_address") "Send tweets TO email_address.",
- Option ['f'][] (ReqArg set_from "email_address") "Send tweets FROM email_address."
- ]
-
-
--- | Attempt to parse an 'Int' from a 'String'. This is just a 'Maybe'
--- wrapper around 'reads'.
-parse_int :: String -> Maybe Int
-parse_int s =
- case (reads s) of
- [(n,_)] -> Just n
- _ -> Nothing
-
-set_heartbeat :: String -> Options -> IO Options
-set_heartbeat arg opts = do
- let new_heartbeat = parse_int arg
- return opts { opt_heartbeat = new_heartbeat }
-
-set_help :: Options -> IO Options
-set_help opts = do
- return opts { opt_help = True }
-
-set_to :: String -> Options -> IO Options
-set_to arg opts = do
- return opts { opt_to = Just arg }
-
-set_from :: String -> Options -> IO Options
-set_from arg opts = do
- return opts { opt_from = Just arg }
-
-
--- The usage header.
-usage :: String
-usage = "Usage: twat [-n heartbeat] [-t to_address] [-f from_address] <username1> [username2, [username3]...]"
-
-
--- The usage header, and all available flags (as generated by GetOpt)
-help_text :: String
-help_text = usageInfo usage options
-
-
--- Return a list of options.
-parse_options :: IO Options
-parse_options = do
- argv <- getArgs
- let (actions, _, _) = getOpt Permute options argv
-
- -- This will execute each of the functions contained in our options
- -- list, one after another, on a default_options record. The end
- -- result should be an Options instance with all of its members set
- -- correctly.
- opts <- foldl (>>=) (return default_options) actions
-
- return opts
-
-
--- | A list of parse errors relating to the heartbeat.
-heartbeat_errors :: IO [String]
-heartbeat_errors = do
- hb <- heartbeat
- if (isNothing hb)
- then return ["\"heartbeat\" does not appear to be an integer."]
- else return []
-
--- |Parse errors relating to the list of usernames.
-username_errors :: IO [String]
-username_errors = do
- argv <- getArgs
- let (_, usernames, _) = getOpt Permute options argv
-
- if (null usernames)
- then return ["no usernames provided."]
- else return []
-
-
--- |Parse errors relating to the "To" address.
-to_errors :: IO [String]
-to_errors = do
- toaddr <- to_email_address
- fromaddr <- from_email_address
- if (isNothing toaddr) && (isJust fromaddr)
- then return ["\"from\" address specified without \"to\" address."]
- else return []
-
-
--- |Parse errors relating to the "From" address.
-from_errors :: IO [String]
-from_errors = do
- toaddr <- to_email_address
- fromaddr <- from_email_address
- if (isJust toaddr) && (isNothing fromaddr)
- then return ["\"to\" address specified without \"from\" address."]
- else return []
-
-
--- |Format an error message for printing.
-format_error :: String -> String
-format_error err = "ERROR: " ++ err ++ "\n"
-
-
--- |Return a list of all parse errors.
-parse_errors :: IO [String]
-parse_errors = do
- argv <- getArgs
- let (_, _, errors) = getOpt Permute options argv
- errs_heartbeat <- heartbeat_errors
- errs_username <- username_errors
- errs_to <- to_errors
- errs_from <- from_errors
- return $ map format_error (errors ++
- errs_heartbeat ++
- errs_username ++
- errs_to ++
- errs_from)
-
--- |Was the "help" option passed on the command line?
-help_set :: IO Bool
-help_set = do
- opts <- parse_options
- return (opt_help opts)
-
--- |What's the heartbeat?
-heartbeat :: IO (Maybe Int)
-heartbeat = do
- opts <- parse_options
- return (opt_heartbeat opts)
-
--- |What "To" address was given on the command line?
-to_email_address :: IO (Maybe String)
-to_email_address = do
- opts <- parse_options
- return (opt_to opts)
-
--- |What "From" address was given on the command line?
-from_email_address :: IO (Maybe String)
-from_email_address = do
- opts <- parse_options
- return (opt_from opts)
-
-
--- |What usernames were passed on the command line?
-parse_usernames :: IO [String]
-parse_usernames = do
- argv <- getArgs
- let (_, usernames, _) = getOpt Permute options argv
- return usernames
+ignore_retweets_help :: String
+ignore_retweets_help = "Ignore retweets from other users"
+
+
+-- | A description of the "pidfile" option.
+pidfile_help :: String
+pidfile_help =
+ "Location to create PID file (daemon only)."
+
+
+-- | A description of the "run_as_group" option.
+run_as_group_help :: String
+run_as_group_help =
+ "System group to run as (daemon only)."
+
+
+-- | A description of the "run_as_user" option.
+run_as_user_help :: String
+run_as_user_help =
+ "System user to run under (daemon only)."
+
+
+-- | Help string for the \"to_address\" option.
+--
+to_address_help :: String
+to_address_help = "Send tweets to ADDRESS"
+
+
+
+-- | Help string for the \"sendmail_path\" option.
+--
+sendmail_path_help :: String
+sendmail_path_help = "Use PATH to send mail"
+
+
+-- | Help string for the \"verbose\" option.
+--
+verbose_help :: String
+verbose_help = "Be verbose about stuff"
+
+
+arg_spec :: OptionalCfg
+arg_spec =
+ OptionalCfg {
+
+ access_secret =
+ def &= typ "SECRET"
+ &= groupname "Twitter API"
+ &= help access_secret_help,
+
+ access_token =
+ def &= typ "TOKEN"
+ &= groupname "Twitter API"
+ &= help access_token_help,
+
+ consumer_key =
+ def &= typ "KEY"
+ &= groupname "Twitter API"
+ &= help consumer_key_help,
+
+ consumer_secret =
+ def &= typ "SECRET"
+ &= groupname "Twitter API"
+ &= help consumer_secret_help,
+
+
+ daemonize =
+ def &= groupname "Miscellaneous"
+ &= help daemonize_help,
+
+ from_address =
+ def &= typ "ADDRESS"
+ &= groupname "Mail Options"
+ &= help from_address_help,
+
+ heartbeat =
+ def &= groupname "Miscellaneous"
+ &= help heartbeat_help,
+
+ ignore_replies =
+ def &= groupname "Miscellaneous"
+ &= help ignore_replies_help,
+
+ ignore_retweets =
+ def &= groupname "Miscellaneous"
+ &= help ignore_retweets_help,
+
+ pidfile =
+ def &= typFile
+ &= help pidfile_help,
+
+ run_as_group =
+ def &= typ "GROUP"
+ &= help run_as_group_help,
+
+ run_as_user =
+ def &= typ "USER"
+ &= help run_as_user_help,
+
+ sendmail_path =
+ def &= typ "PATH"
+ &= groupname "Mail Options"
+ &= help sendmail_path_help,
+
+ to_address =
+ def &= typ "ADDRESS"
+ &= groupname "Mail Options"
+ &= help to_address_help,
+
+ usernames =
+ def &= args
+ &= typ "USERNAMES",
+
+ verbose =
+ def &= groupname "Miscellaneous"
+ &= help verbose_help }
+
+ &= program program_name
+ &= summary my_summary
+ &= details [description]
+ &= helpArg [groupname "Common flags"]
+ &= versionArg [groupname "Common flags"]
+
+
+show_help :: IO OptionalCfg
+show_help = withArgs ["--help"] get_args
+
+
+get_args :: IO OptionalCfg
+get_args = cmdArgs arg_spec