大改，整理项目结构，完成rust ffi调用，写好tcp接口

chusql-cli/app/Main.hs

@@ -11,19 +11,11 @@ import ChuSQL.CLI.Session (
     newSession,
     switchDatabase,
  )
-import ChuSQL.Web.Auth (Credential (..))
-import ChuSQL.Web.Backend (ipcBackend)
-import ChuSQL.Web.Config (WebConfig (..), defaultPassword, loadWebConfigAt, resolveCredential, resolvePipeName)
-import ChuSQL.Web.Settings (readSettingsFile)
-import ChuSQL.Web.TOML (resolveConfigPath)
-import ChuSQL.Web.StorageProcess (
-    StorageProcess,
-    findStorageServer,
-    startStorageProcessAt,
-    stopStorageProcess,
-    waitForStorage,
- )
-import ChuSQL.Storage.IPC (setPipeName)
+import ChuSQL.Interface.Auth (Credential (..))
+import ChuSQL.Interface.Config (ServerConfig (..), loadServerConfigAt, loadWebConfigAt, resolveCredential, resolvePlainPassword)
+import ChuSQL.Interface.Link (Client, closeClient, connectClient)
+import ChuSQL.Interface.Settings (readSettingsFile)
+import ChuSQL.Interface.TOML (resolveConfigPath)
 import Control.Exception (finally)
 import Control.Monad (unless)
 import Data.IORef (newIORef)
@@ -39,7 +31,7 @@ import System.Exit (exitFailure)
 import System.FilePath ((</>))
 import System.IO (hSetEncoding, stderr, stdout, utf8)
 
--- chusql-cli：与 Web 管理端并列的前端，直连存储与引擎，账号与 Web 共用。
+-- chusql-cli：与 Web 管理端并列的前端，接到拥有存储的 server 上跑 SQL，账号与 Web 共用。
 
 data Options = Options
     { optUser :: Maybe Text
@@ -48,11 +40,10 @@ data Options = Options
     , optFormat :: OutputFormat
     , optExecute :: Maybe Text
     , optHistory :: Maybe FilePath
-    , optPipe :: Maybe String
-    , optStorage :: Maybe FilePath
     , optConfig :: Maybe FilePath
     }
 
+-- | 命令行参数解析器
 optionsParser :: Parser Options
 optionsParser =
     Options
@@ -78,13 +69,13 @@ optionsParser =
             )
         <*> optional (T.pack <$> strOption (long "execute" <> short 'e' <> metavar "SQL" <> help "Run one statement and exit"))
         <*> optional (strOption (long "history" <> metavar "FILE" <> help "SQL history file (default ~/.chusql_history)"))
-        <*> optional (strOption (long "pipe" <> metavar "NAME" <> help "Endpoint name of the storage process (Windows named pipe, Unix socket file; default: [server] pipe_name in chusql.toml)"))
-        <*> optional (strOption (long "storage" <> metavar "SERVER" <> help "Rust storage executable to spawn when nothing answers the endpoint"))
         <*> optional (strOption (long "config" <> metavar "FILE" <> help "Config file to read (default: the fixed chusql.toml under the system config directory)"))
 
+-- | 把 --format 的取值解析成格式
 formatReader :: String -> Either String OutputFormat
 formatReader raw = maybe (Left "format must be table, json or csv") Right (parseFormat (T.pack raw))
 
+-- | 命令行界面与帮助
 parserInfo :: ParserInfo Options
 parserInfo =
     info
@@ -94,6 +85,7 @@ parserInfo =
             <> header "csql - the ChuSQL command line client"
         )
 
+-- | 解析参数、登录 server 后进入会话
 main :: IO ()
 main = do
     hSetEncoding stdout utf8
@@ -101,31 +93,29 @@ main = do
     options <- execParser parserInfo
     configPath <- resolveConfigPath (optConfig options)
     base <- loadWebConfigAt configPath
-    let settingsFile = configPath
-    saved <- readSettingsFile settingsFile
+    saved <- readSettingsFile configPath
     credential <- resolveCredential base saved
+    config <- loadServerConfigAt configPath
     let rootName = credUser credential
         userName = fromMaybe rootName (optUser options)
-        pipeName = resolvePipe options base
-    setPipeName pipeName
     password <- resolvePassword (optPromptPassword options) userName rootName saved
-    storage <- acquireStorage options pipeName settingsFile
-    case storage of
+    connected <- connectClient (T.pack (scHost config)) (scPort config)
+    case connected of
         Left message -> reportError message >> exitFailure
-        Right spawned ->
-            connect options credential settingsFile userName password
-                `finally` maybe (pure ()) stopStorageProcess spawned
+        Right client ->
+            connect options client userName password
+                `finally` closeClient client
 
--- | 接上存储，登录，然后进交互或跑单条语句
-connect :: Options -> Credential -> FilePath -> Text -> Text -> IO ()
-connect options credential settingsFile userName password = do
-    backend <- ipcBackend
-    session <- newSession backend credential settingsFile
+-- | 连 server、登录，之后转入会话
+connect :: Options -> Client -> Text -> Text -> IO ()
+connect options client userName password = do
+    session <- newSession client
     signedIn <- authenticateSession session userName password
     case signedIn of
         Left message -> reportError message >> exitFailure
         Right () -> runSession options session
 
+-- | 执行 -e 的单条语句，否则进交互循环
 runSession :: Options -> Session -> IO ()
 runSession options session = do
     formatRef <- newIORef (optFormat options)
@@ -140,7 +130,7 @@ runSession options session = do
                 historyFile <- resolveHistory (optHistory options)
                 runRepl session formatRef historyFile
 
--- | 只有 -d 明确给了一个库才切；没给就保持"未选库"（服务没有默认库）
+-- | -d 指定了库才切，否则保持未选库
 selectDatabase :: Session -> Text -> IO Bool
 selectDatabase _ wanted | T.null wanted = pure True
 selectDatabase session wanted
@@ -151,54 +141,20 @@ selectDatabase session wanted
             Left message -> reportError message >> pure False
             Right () -> pure True
 
--- | 口令：-p 强制交互输入；否则配置里的 root 明文（同 Web）> 交互输入
+-- | 决定口令是交互输入还是取自配置
 resolvePassword :: Bool -> Text -> Text -> Map.Map Text Text -> IO Text
 resolvePassword forcePrompt userName rootName saved
     | forcePrompt = promptPassword userName
-    | T.toLower userName == T.toLower rootName = pure (configuredPassword saved)
+    | T.toLower userName == T.toLower rootName = pure (resolvePlainPassword saved)
     | otherwise = promptPassword userName
-  where
-    configuredPassword values = case nonEmpty (Map.lookup "password" values) of
-        Just plain -> plain
-        Nothing -> defaultPassword
 
+-- | 交互式读取口令
 promptPassword :: Text -> IO Text
 promptPassword user = do
     entered <- runInputT defaultSettings (getPassword (Just '*') (T.unpack user <> "'s password: "))
     pure (maybe "" T.pack entered)
 
--- | 先找已经在跑的存储；--storage 给了可执行文件才自己拉一个
-acquireStorage :: Options -> String -> FilePath -> IO (Either Text (Maybe StorageProcess))
-acquireStorage options pipeName configPath = do
-    up <- waitForStorage 4
-    case optStorage options of
-        Nothing
-            | up -> pure (Right Nothing)
-            | otherwise ->
-                pure
-                    ( Left
-                        ( "no storage process answered on pipe "
-                            <> T.pack pipeName
-                            <> "; start the server first, or pass --storage <path>"
-                        )
-                    )
-        Just given
-            | up -> pure (Right Nothing)
-            | otherwise -> do
-                found <- findStorageServer (Just given)
-                case found of
-                    Left err -> pure (Left (T.pack err))
-                    Right binary -> fmap (either (Left . T.pack) (Right . Just)) (startStorageProcessAt binary pipeName configPath)
-
--- | 管名：--pipe > chusql.toml 的 [server] pipe_name（缺省 chusql-joint）
-resolvePipe :: Options -> WebConfig -> String
-resolvePipe options base = fromMaybe (resolvePipeName base) (optPipe options)
-
-nonEmpty :: Maybe Text -> Maybe Text
-nonEmpty given = case T.strip <$> given of
-    Just text | not (T.null text) -> Just text
-    _ -> Nothing
-
+-- | 取历史文件路径，没给就用默认
 resolveHistory :: Maybe FilePath -> IO (Maybe FilePath)
 resolveHistory (Just path) = pure (Just path)
 resolveHistory Nothing = do

chusql-cli/app/Repl.hs

@@ -8,9 +8,9 @@ module Repl
 
 import ChuSQL.CLI.Format (OutputFormat, formatName, renderResult, renderRows)
 import ChuSQL.CLI.Script (Meta (..), errorHint, metaHelp, parseMeta, takeStatement)
-import ChuSQL.CLI.Session (Session, accountTable, catalog, databases, roleViews, runStatement, sessionDatabase, switchDatabase)
-import ChuSQL.Storage.IPC (SchemaColumn (..), TableInfo (..))
-import ChuSQL.Web.Privileges (Grant (..), RoleView (..))
+import ChuSQL.CLI.Session (Session, catalog, databases, roleViews, runStatement, sessionDatabase, switchDatabase)
+import ChuSQL.Core.Protocol (SchemaColumn (..), TableInfo (..))
+import ChuSQL.Interface.Protocol (Grant (..), RoleView (..))
 import Control.Monad (forM_, when)
 import Control.Monad.IO.Class (liftIO)
 import Data.IORef (IORef, readIORef, writeIORef)
@@ -22,7 +22,7 @@ import System.IO (hIsTerminalDevice, stderr, stdin)
 
 -- 交互层：提示符、多行输入、历史、元命令与错误提示。
 
--- | 交互循环；historyPath 为 Nothing 就不落盘历史
+-- | 交互循环，没有历史文件就不落盘
 runRepl :: Session -> IORef OutputFormat -> Maybe FilePath -> IO ()
 runRepl session formatRef historyPath =
     runInputT (defaultSettings{historyFile = historyPath}) (loop session formatRef T.empty)
@@ -41,6 +41,7 @@ runStatementOnce session format sql = do
         Left message -> reportError message >> pure False
         Right answer -> TIO.putStrLn (renderResult format answer) >> pure True
 
+-- | 读一行输入，分派到元命令或语句缓冲
 loop :: Session -> IORef OutputFormat -> Text -> InputT IO ()
 loop session formatRef buffer = do
     prompt <- liftIO (promptFor session buffer)
@@ -62,7 +63,7 @@ loop session formatRef buffer = do
                         remaining <- drain session formatRef extended
                         loop session formatRef remaining
 
--- | 提示符带上当前库；续行换个样子，方便看出语句还没写完；管道输入时不出提示符
+-- | 生成提示符；续行与非终端输入另有样式
 promptFor :: Session -> Text -> IO Text
 promptFor session buffer = do
     interactive <- hIsTerminalDevice stdin
@@ -83,6 +84,7 @@ drain session formatRef buffer = case takeStatement buffer of
         when (not (T.null statement)) (runOne session formatRef statement)
         drain session formatRef rest
 
+-- | 执行一条语句并打印结果
 runOne :: Session -> IORef OutputFormat -> Text -> InputT IO ()
 runOne session formatRef statement = do
     result <- liftIO (runStatement session statement)
@@ -92,6 +94,7 @@ runOne session formatRef statement = do
             format <- liftIO (readIORef formatRef)
             outputStrLn (T.unpack (renderResult format answer))
 
+-- | 执行元命令，返回是否继续循环
 runMeta :: Session -> IORef OutputFormat -> Meta -> InputT IO Bool
 runMeta session formatRef meta = case meta of
     MetaQuit -> pure False
@@ -120,17 +123,16 @@ listDatabases session = do
         Left message -> liftIO (reportError message)
         Right names -> outputStrLn (T.unpack (renderRows ["database"] (map (: []) names)))
 
--- | \dt：表清单（base 里补上账号表）
+-- | \dt：表清单（含 server 补的账号表）
 listTables :: Session -> InputT IO ()
 listTables session = do
     answer <- liftIO (catalog session)
     case answer of
         Left message -> liftIO (reportError message)
-        Right tables -> do
-            allTables <- liftIO (withAccountTable session tables)
-            outputStrLn (T.unpack (renderRows headers (map tableRow allTables)))
+        Right tables -> outputStrLn (T.unpack (renderRows headers (map tableRow tables)))
   where
     headers = ["table", "columns", "rows", "indexes"]
+    -- | 把表信息排成一行
     tableRow info =
         [ T.pack (tiTable info)
         , tshow (length (tiColumns info))
@@ -144,14 +146,15 @@ describeTable session name = do
     answer <- liftIO (catalog session)
     case answer of
         Left message -> liftIO (reportError message)
-        Right tables -> do
-            allTables <- liftIO (withAccountTable session tables)
-            case filter (matches name) allTables of
+        Right tables ->
+            case filter (matches name) tables of
                 [] -> liftIO (reportError ("unknown table: " <> name))
                 (info : _) -> outputStrLn (T.unpack (renderRows headers (map columnRow (tiColumns info))))
   where
     headers = ["column", "type", "primary", "unique", "nullable", "auto"]
+    -- | 表名忽略大小写比较
     matches wanted info = T.toLower (T.pack (tiTable info)) == T.toLower wanted
+    -- | 把列信息排成一行
     columnRow column =
         [ T.pack (scName column)
         , T.pack (scType column)
@@ -160,6 +163,7 @@ describeTable session name = do
         , yesNo (scNullable column)
         , yesNo (scAutoIncrement column)
         ]
+    -- | 布尔值转成 yes/no
     yesNo True = "yes"
     yesNo False = "no"
 
@@ -171,22 +175,15 @@ listRoles session = do
         Left message -> liftIO (reportError message)
         Right roles -> outputStrLn (T.unpack (renderRows ["role", "grants", "members"] (map roleRow roles)))
   where
+    -- | 把角色信息排成一行
     roleRow view =
         [ roleName view
         , if null (roleGrants view) then "-" else T.intercalate ", " (map grantText (roleGrants view))
         , if null (roleMembers view) then "-" else T.intercalate ", " (roleMembers view)
         ]
+    -- | 拼一条授权说明
     grantText grant = grantPrivilege grant <> " on " <> grantObject grant
 
--- | 当前库是 system 时，把账号表也列出来（与 Web 端一致）
-withAccountTable :: Session -> [TableInfo] -> IO [TableInfo]
-withAccountTable session tables = do
-    current <- sessionDatabase session
-    if current /= "system"
-        then pure tables
-        else do
-            extra <- accountTable session
-            pure (maybe tables (: tables) extra)
-
+-- | 用 show 转成 Text
 tshow :: Show a => a -> Text
 tshow = T.pack . show