content: {-| Implementation of DataCollectors CLI functions.
  
  This module holds the common command-line related functions for the
  collector binaries.
  
  -}
  
  {-
  
  Copyright (C) 2009, 2010, 2011, 2012 Google Inc.
  All rights reserved.
  
  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are
  met:
  
  1. Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
  
  2. Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.
  
  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  
  -}
  
  module Ganeti.DataCollectors.CLI
    ( Options(..)
    , OptType
    , defaultOptions
    -- * The options
    , oShowHelp
    , oShowVer
    , oShowComp
    , oDrbdPairing
    , oDrbdStatus
    , oNode
    , oConfdAddr
    , oConfdPort
    , oInputFile
    , oInstances
    , genericOptions
    ) where
  
  import System.Console.GetOpt
  
  import Ganeti.BasicTypes
  import Ganeti.Common as Common
  import Ganeti.Utils
  
  
  -- * Data types
  
  -- | Command line options structure.
  data Options = Options
    { optShowHelp    :: Bool           -- ^ Just show the help
    , optShowComp    :: Bool           -- ^ Just show the completion info
    , optShowVer     :: Bool           -- ^ Just show the program version
    , optDrbdStatus  :: Maybe FilePath -- ^ Path to the file containing DRBD
                                       -- status information
    , optDrbdPairing :: Maybe FilePath -- ^ Path to the file containing pairings
                                       -- between instances and DRBD minors
    , optNode        :: Maybe String   -- ^ Info are requested for this node
    , optConfdAddr   :: Maybe String   -- ^ IP address of the Confd server
    , optConfdPort   :: Maybe Int      -- ^ The port of the Confd server to
                                       -- connect to
    , optInputFile   :: Maybe FilePath -- ^ Path to the file containing the
                                       -- information to be parsed
    , optInstances   :: Maybe FilePath -- ^ Path to the file contained a
                                       -- serialized list of instances as in:
                                       -- ([Primary], [Secondary])
    } deriving Show
  
  -- | Default values for the command line options.
  defaultOptions :: Options
  defaultOptions  = Options
    { optShowHelp    = False
    , optShowComp    = False
    , optShowVer     = False
    , optDrbdStatus  = Nothing
    , optDrbdPairing = Nothing
    , optNode        = Nothing
    , optConfdAddr   = Nothing
    , optConfdPort   = Nothing
    , optInputFile   = Nothing
    , optInstances   = Nothing
    }
  
  -- | Abbreviation for the option type.
  type OptType = GenericOptType Options
  
  instance StandardOptions Options where
    helpRequested = optShowHelp
    verRequested  = optShowVer
    compRequested = optShowComp
    requestHelp o = o { optShowHelp = True }
    requestVer  o = o { optShowVer  = True }
    requestComp o = o { optShowComp = True }
  
  -- * Command line options
  oDrbdPairing :: OptType
  oDrbdPairing =
    ( Option "p" ["drbd-pairing"]
        (ReqArg (\ f o -> Ok o { optDrbdPairing = Just f}) "FILE")
        "the FILE containing pairings between instances and DRBD minors",
      OptComplFile)
  
  oDrbdStatus :: OptType
  oDrbdStatus =
    ( Option "s" ["drbd-status"]
        (ReqArg (\ f o -> Ok o { optDrbdStatus = Just f }) "FILE")
        "the DRBD status FILE",
      OptComplFile)
  
  oNode :: OptType
  oNode =
    ( Option "n" ["node"]
        (ReqArg (\ n o -> Ok o { optNode = Just n }) "NODE")
        "the FQDN of the NODE about which information is requested",
      OptComplFile)
  
  oConfdAddr :: OptType
  oConfdAddr =
    ( Option "a" ["address"]
        (ReqArg (\ a o -> Ok o { optConfdAddr = Just a }) "IP_ADDR")
        "the IP address of the Confd server to connect to",
      OptComplFile)
  
  oConfdPort :: OptType
  oConfdPort =
    (Option "p" ["port"]
      (reqWithConversion (tryRead "reading port")
        (\port opts -> Ok opts { optConfdPort = Just port }) "PORT")
      "Network port of the Confd server to connect to",
      OptComplInteger)
  
  oInputFile :: OptType
  oInputFile =
    ( Option "f" ["file"]
        (ReqArg (\ f o -> Ok o { optInputFile = Just f }) "FILE")
        "the input FILE",
      OptComplFile)
  
  oInstances :: OptType
  oInstances =
    ( Option "i" ["instances"]
        (ReqArg (\ f o -> Ok o { optInstances = Just f}) "FILE")
        "the FILE containing serialized instances",
      OptComplFile)
  
  -- | Generic options.
  genericOptions :: [GenericOptType Options]
  genericOptions =  [ oShowVer
                    , oShowHelp
                    , oShowComp
                    ]
  