{-# LANGUAGE ApplicativeDo #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE LambdaCase #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE ScopedTypeVariables #-} module Simplex.Chat.Options ( ChatOpts (..), CoreChatOpts (..), CreateBotOpts (..), ChatCmdLog (..), chatOptsP, coreChatOptsP, getChatOpts, protocolServersP, defaultHostMode, printDbOpts, ) where import Control.Logger.Simple (LogLevel (..)) import qualified Data.Attoparsec.ByteString.Char8 as A import qualified Data.ByteString.Char8 as B import Data.Maybe (fromMaybe) import Data.Text (Text) import qualified Data.Text as T import Data.Text.Encoding (encodeUtf8) import Numeric.Natural (Natural) import Options.Applicative import Simplex.Chat.Controller (ChatLogLevel (..), SimpleNetCfg (..), updateStr, versionNumber, versionString) import Simplex.FileTransfer.Description (mb) import Simplex.Messaging.Client (HostMode (..), SMPWebPortServers (..), SocksMode (..), textToHostMode) import Simplex.Messaging.Encoding.String import Simplex.Messaging.Parsers (parseAll) import Simplex.Messaging.Protocol (ProtoServerWithAuth, ProtocolTypeI, SMPServerWithAuth, XFTPServerWithAuth) import Simplex.Messaging.Transport.Client (SocksProxyWithAuth (..), SocksAuth (..), defaultSocksProxyWithAuth) import Simplex.Chat.Options.DB data ChatOpts = ChatOpts { coreOptions :: CoreChatOpts, chatCmd :: String, chatCmdDelay :: Int, chatCmdLog :: ChatCmdLog, chatServerPort :: Maybe String, optFilesFolder :: Maybe FilePath, optTempDirectory :: Maybe FilePath, showReactions :: Bool, allowInstantFiles :: Bool, autoAcceptFileSize :: Integer, muteNotifications :: Bool, markRead :: Bool, createBot :: Maybe CreateBotOpts, maintenance :: Bool } data CoreChatOpts = CoreChatOpts { dbOptions :: ChatDbOpts, smpServers :: [SMPServerWithAuth], xftpServers :: [XFTPServerWithAuth], simpleNetCfg :: SimpleNetCfg, logLevel :: ChatLogLevel, logConnections :: Bool, logServerHosts :: Bool, logAgent :: Maybe LogLevel, logFile :: Maybe FilePath, tbqSize :: Natural, deviceName :: Maybe Text, chatRelay :: Bool, highlyAvailable :: Bool, yesToUpMigrations :: Bool, migrationBackupPath :: Maybe FilePath } data CreateBotOpts = CreateBotOpts { botDisplayName :: Text, allowFiles :: Bool } data ChatCmdLog = CCLAll | CCLMessages | CCLNone deriving (Eq) agentLogLevel :: ChatLogLevel -> LogLevel agentLogLevel = \case CLLDebug -> LogDebug CLLInfo -> LogInfo CLLWarning -> LogWarn CLLError -> LogError CLLImportant -> LogInfo coreChatOptsP :: FilePath -> FilePath -> Parser CoreChatOpts coreChatOptsP appDir defaultDbName = do dbOptions <- chatDbOptsP appDir defaultDbName smpServers <- option parseProtocolServers ( long "server" <> short 's' <> metavar "SERVER" <> help ( ("Space-separated list of SMP server(s) to use (each server can have more than one hostname)." <> "\n") <> ("If you pass multiple servers, surround the entire list in quotes." <> "\n") <> "Examples: smp1.example.com, \"smp1.example.com smp2.example.com smp3.example.com\"" ) <> value [] ) xftpServers <- option parseProtocolServers ( long "xftp-server" <> metavar "SERVER" <> help ( ("Space-separated list of XFTP server(s) to use (each server can have more than one hostname)." <> "\n") <> ("If you pass multiple servers, surround the entire list in quotes." <> "\n") <> "Examples: xftp1.example.com, \"xftp1.example.com xftp2.example.com xftp3.example.com\"" ) <> value [] ) socksProxy <- flag' (Just defaultSocksProxyWithAuth) (short 'x' <> help "Use local SOCKS5 proxy at :9050") <|> option strParse ( long "socks-proxy" <> metavar "SOCKS5" <> help "Use SOCKS5 proxy at `ipv4:port` or `:port`" <> value Nothing ) socksMode <- option strParse ( long "socks-mode" <> metavar "SOCKS_MODE" <> help "Use SOCKS5 proxy: always (default), onion (with onion-only relays)" <> value SMAlways ) hostMode_ <- optional $ option parseHostMode ( long "host-mode" <> metavar "HOST_MODE" <> help "Preferred server host type: onion (when SOCKS proxy with isolate-by-auth is used), public" ) requiredHostMode <- switch ( long "required-host-mode" <> help "Refuse connection if preferred server host type is not available" ) smpProxyMode_ <- optional $ option strParse ( long "smp-proxy" <> metavar "SMP_PROXY_MODE" <> help "Use private message routing: always, unknown (default), unprotected, never" ) smpProxyFallback_ <- optional $ option strParse ( long "smp-proxy-fallback" <> metavar "SMP_PROXY_FALLBACK_MODE" <> help "Allow downgrade and connect directly: no, [when IP address is] protected (default), yes" ) smpWebPortServers <- flag' SWPAll ( long "smp-web-port" <> help "Use port 443 with SMP servers when not specified" ) <|> option strParse ( long "smp-web-port-servers" <> help "Use port 443 with SMP servers when not specified: all, preset (default), off" <> value SWPPreset ) t <- option auto ( long "tcp-timeout" <> metavar "TIMEOUT" <> help "TCP timeout, seconds (default: 7/15 without/with SOCKS5 proxy)" <> value 0 ) logLevel <- option parseLogLevel ( long "log-level" <> short 'l' <> metavar "LEVEL" <> help "Log level: debug, info, warn, error, important (default)" <> value CLLImportant ) logTLSErrors <- switch ( long "log-tls-errors" <> help "Log TLS errors" ) logConnections <- switch ( long "connections" <> short 'c' <> help "Log connections subscription errors on start (also with `-l info`)" ) logServerHosts <- switch ( long "log-hosts" <> help "Log connections to servers (also with `-l info`)" ) logAgent <- switch ( long "log-agent" <> help "Enable logs from SMP agent (also with `-l debug`)" ) logFile <- optional $ strOption ( long "log-file" <> help "Log to specified file / device" ) tbqSize <- option auto ( long "queue-size" <> short 'q' <> metavar "SIZE" <> help "Internal queue size" <> value 1024 <> showDefault ) deviceName <- optional $ strOption ( long "device-name" <> metavar "DEVICE" <> help "Device name to use in connections with remote hosts and controller" ) chatRelay <- switch ( long "relay" <> help "Run as a chat relay client" ) highlyAvailable <- switch ( long "ha" <> help "Run as a highly available client (this may increase traffic in groups)" ) yesToUpMigrations <- switch ( long "yes-migrate" <> short 'y' <> help "Automatically confirm \"up\" database migrations" ) migrationBackupPath <- migrationBackupPathP pure CoreChatOpts { dbOptions, smpServers, xftpServers, simpleNetCfg = SimpleNetCfg { socksProxy, socksMode, hostMode = fromMaybe (defaultHostMode socksProxy) hostMode_, requiredHostMode, smpProxyMode_, smpProxyFallback_, smpWebPortServers, tcpTimeout_ = Just $ useTcpTimeout socksProxy t, logTLSErrors }, logLevel, logConnections = logConnections || logLevel <= CLLInfo, logServerHosts = logServerHosts || logLevel <= CLLInfo, logAgent = if logAgent || logLevel == CLLDebug then Just $ agentLogLevel logLevel else Nothing, logFile, tbqSize, deviceName, chatRelay, highlyAvailable, yesToUpMigrations, migrationBackupPath } where useTcpTimeout p t = 1000000 * if t > 0 then t else maybe 7 (const 15) p defaultHostMode :: Maybe SocksProxyWithAuth -> HostMode defaultHostMode = \case Just (SocksProxyWithAuth SocksIsolateByAuth _) -> HMOnionViaSocks; _ -> HMPublic chatOptsP :: FilePath -> FilePath -> Parser ChatOpts chatOptsP appDir defaultDbName = do coreOptions <- coreChatOptsP appDir defaultDbName chatCmd <- strOption ( long "execute" <> short 'e' <> metavar "COMMAND" <> help "Execute chat command (received messages won't be logged) and exit" <> value "" ) chatCmdDelay <- option auto ( long "time" <> short 't' <> metavar "TIME" <> help "Time to wait after sending chat command before exiting, seconds" <> value 3 <> showDefault ) chatCmdLog <- option parseChatCmdLog ( long "execute-log" <> metavar "EXEC_LOG" <> help "Log during command execution: all, messages, none (default)" <> value CCLNone ) chatServerPort <- option parseServerPort ( long "chat-server-port" <> short 'p' <> metavar "PORT" <> help "Run chat server on specified port" <> value Nothing ) optFilesFolder <- optional $ strOption ( long "files-folder" <> metavar "FOLDER" <> help "Folder to use for sent and received files" ) optTempDirectory <- optional $ strOption ( long "temp-folder" <> metavar "FOLDER" <> help "Folder for temporary encrypted files (default: system temp directory)" ) showReactions <- switch ( long "reactions" <> help "Show message reactions" ) allowInstantFiles <- switch ( long "allow-instant-files" <> short 'f' <> help "Send and receive instant files without acceptance" ) autoAcceptFileSize <- flag' (mb 1) (short 'a' <> help "Automatically accept files up to 1MB") <|> option auto ( long "auto-accept-files" <> metavar "FILE_SIZE" <> help "Automatically accept files up to specified size" <> value 0 ) muteNotifications <- switch ( long "mute" <> help "Mute notifications" ) markRead <- switch ( long "mark-read" <> short 'r' <> help "Mark shown messages as read" ) createBotDisplayName <- optional $ strOption ( long "create-bot-display-name" <> metavar "BOT_NAME" <> help "Create new bot user on the first start with the passed display name" ) createBotAllowFiles <- switch ( long "create-bot-allow-files" <> help "Flag for created bot to allow files (only allowed together with --create-bot option)" ) maintenance <- switch ( long "maintenance" <> short 'm' <> help "Run in maintenance mode (/_start to start chat)" ) pure ChatOpts { coreOptions, chatCmd, chatCmdDelay, chatCmdLog, chatServerPort, optFilesFolder, optTempDirectory, showReactions, allowInstantFiles, autoAcceptFileSize, muteNotifications, markRead, createBot = case createBotDisplayName of Just botDisplayName -> Just CreateBotOpts {botDisplayName, allowFiles = createBotAllowFiles} Nothing | createBotAllowFiles -> error "--create-bot-allow-files option requires --create-bot-name option" | otherwise -> Nothing, maintenance } parseProtocolServers :: ProtocolTypeI p => ReadM [ProtoServerWithAuth p] parseProtocolServers = eitherReader $ parseAll protocolServersP . B.pack strParse :: StrEncoding a => ReadM a strParse = eitherReader $ parseAll strP . encodeUtf8 . T.pack parseHostMode :: ReadM HostMode parseHostMode = eitherReader $ textToHostMode . T.pack parseServerPort :: ReadM (Maybe String) parseServerPort = eitherReader $ parseAll serverPortP . B.pack serverPortP :: A.Parser (Maybe String) serverPortP = Just . B.unpack <$> A.takeWhile A.isDigit protocolServersP :: ProtocolTypeI p => A.Parser [ProtoServerWithAuth p] protocolServersP = strP `A.sepBy1` A.char ' ' parseLogLevel :: ReadM ChatLogLevel parseLogLevel = eitherReader $ \case "debug" -> Right CLLDebug "info" -> Right CLLInfo "warn" -> Right CLLWarning "error" -> Right CLLError "important" -> Right CLLImportant _ -> Left "Invalid log level" parseChatCmdLog :: ReadM ChatCmdLog parseChatCmdLog = eitherReader $ \case "all" -> Right CCLAll "messages" -> Right CCLMessages "none" -> Right CCLNone _ -> Left "Invalid chat command log level" getChatOpts :: FilePath -> FilePath -> IO ChatOpts getChatOpts appDir defaultDbName = execParser $ info (helper <*> versionOption <*> chatOptsP appDir defaultDbName) (header versionStr <> fullDesc <> progDesc "Start chat with DB_FILE file and use SERVER as SMP server") where versionStr = versionString versionNumber versionOption = infoOption versionAndUpdate (long "version" <> short 'v' <> help "Show version") versionAndUpdate = versionStr <> "\n" <> updateStr printDbOpts :: CoreChatOpts -> IO () printDbOpts opts = putStrLn $ "db: " <> dbString (dbOptions opts)