{-# LANGUAGE FlexibleContexts #-} {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE GeneralizedNewtypeDeriving #-} {-# LANGUAGE MultiParamTypeClasses #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE ScopedTypeVariables #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE Trustworthy #-} {-# LANGUAGE TypeFamilies #-} {-# OPTIONS_GHC -fno-warn-orphans #-} ------------------------------------------------------------------- -- | -- Module : Network.MessagePackRpc.Server -- Copyright : (c) Hideyuki Tanaka, 2010-2015 -- License : BSD3 -- -- Maintainer: tanaka.hideyuki@gmail.com -- Stability : experimental -- Portability: portable -- -- This module is server library of MessagePack-RPC. -- The specification of MessagePack-RPC is at -- . -- -- A simple example: -- -- > import Network.MessagePackRpc.Server -- > -- > add :: Int -> Int -> Server Int -- > add x y = return $ x + y -- > -- > main = serve 1234 [ method "add" add ] -- -------------------------------------------------------------------- module Network.MessagePack.Server.Basic ( -- * RPC method types Method , MethodVal (..) , MethodDocs (..) , MethodType (..) , ServerT (..) , Server -- * Build a method , method -- * Get the method name , methodName , methodDocs -- * Start RPC server , serve ) where import Control.Applicative (Applicative, pure, (<$>), (<|>)) import Control.Monad.Catch (MonadCatch, MonadThrow, catch, throwM) import Control.Monad.IO.Unlift (MonadUnliftIO) import Control.Monad.Trans (MonadIO, MonadTrans, lift, liftIO) import Control.Monad.Trans.Control (MonadBaseControl) import Control.Monad.Validate (runValidate) import qualified Data.Binary as Binary import qualified Data.ByteString as S import Data.Conduit (ConduitT, SealedConduitT, Void, runConduit, ($$+), ($$++), (.|)) import qualified Data.Conduit.Binary as CB import Data.Conduit.Network (appSink, appSource, runGeneralTCPServer, serverSettings, setAfterBind) import Data.Conduit.Serialization.Binary (ParseError, sinkGet) import qualified Data.List as List import Data.MessagePack (MessagePack, Object, defaultConfig, fromObject, fromObjectWith, toObject) import Data.Monoid ((<>)) import qualified Data.Text as T import Data.Traversable (sequenceA) import qualified Network.MessagePack.Types.Result as R import Network.Socket (SocketOption (ReuseAddr), setSocketOption) import Network.MessagePack.Interface (IsReturnType (..), Returns, ReturnsM) import Network.MessagePack.Types newtype ServerT m a = ServerT { runServerT :: m a } deriving (Functor, Applicative, Monad, MonadIO, MonadFail) instance MonadTrans ServerT where lift = ServerT {-# INLINE lift #-} type Server = ServerT IO instance (MonadThrow m, MessagePack o, MethodType m r) => MethodType m (o -> r) where toBody n f (x : xs) = case runValidate . fromObjectWith defaultConfig $ x of Left err -> throwM $ ServerError $ "argument type error: " <> T.pack (show err) Right ok -> toBody n (f ok) xs toBody _ _ [] = error "messagepack-rpc methodtype instance toBody failed" instance (Functor m, MonadThrow m, MessagePack o) => MethodType m (ServerT m o) where toBody _ m [] = toObject defaultConfig <$> runServerT m toBody n _ ls = throwM $ ServerError $ "invalid arguments for method '" <> n <> "': " <> T.pack (show ls) -- Pure server instance Monad m => IsReturnType m (Returns r) where type HaskellType (Returns r) = r type ServerType m (Returns r) = ServerT m r implement _ = return -- IO Server instance MonadIO m => IsReturnType m (ReturnsM IO r) where type HaskellType (ReturnsM IO r) = IO r type ServerType m (ReturnsM IO r) = ServerT m r implement _ = liftIO processRequests :: (Applicative m, MonadThrow m, MonadCatch m) => [Method m] -> SealedConduitT () S.ByteString m () -> ConduitT S.ByteString Void m t -> m b processRequests methods rsrc sink = do (rsrc', res) <- rsrc $$++ do obj <- sinkGet Binary.get case unpackRequest obj of Left err -> throwM . ServerError . T.pack . show $ err Right req@(_, msgid, _, _) -> lift $ getResponse methods req `catch` \(ServerError err) -> return (1, msgid, toObject defaultConfig err, toObject defaultConfig ()) _ <- runConduit $ CB.sourceLbs (packResponse res) .| sink processRequests methods rsrc' sink getResponse :: Applicative m => [Method m] -> Request Object -> m Response getResponse methods (0, msgid, mth, args) = process <$> callMethod methods mth args where process (R.Failure err) = (1, msgid, toObject defaultConfig err, toObject defaultConfig ()) process (R.Success ok ) = (1, msgid, toObject defaultConfig (), ok) getResponse _ (rtype, msgid, _, _) = pure (1, msgid, toObject defaultConfig ["request type is not 0, got " <> T.pack (show rtype)], toObject defaultConfig ()) callMethod :: (Applicative m) => [Method m] -> Object -> [Object] -> m (R.Result Object) callMethod methods mth args = sequenceA $ (stringCall =<< fromObject mth) <|> (intCall =<< fromObject mth) where stringCall name = case List.find ((== name) . methodName) methods of Nothing -> R.Failure $ "method '" <> T.unpack name <> "' not found" Just m -> R.Success $ methodBody m args intCall ix = case drop ix methods of [] -> R.Failure $ "method #" <> show ix <> " not found" m:_ -> R.Success $ methodBody m args ignoreParseError :: Applicative m => ParseError -> m () ignoreParseError _ = pure () -- | Start RPC server with a set of RPC methods. serve :: (MonadBaseControl IO m, MonadIO m, MonadCatch m, MonadUnliftIO m) => Int -- ^ Port number -> [Method m] -- ^ list of methods -> m () serve port methods = runGeneralTCPServer settings $ \ad -> do (rsrc, _) <- appSource ad $$+ return () processRequests methods rsrc (appSink ad) `catch` ignoreParseError where settings = setAfterBind (\s -> setSocketOption s ReuseAddr 1) (serverSettings port "*")