src/Gargantext/API.hs

   1 {-|
   2 Module      : Gargantext.API
   3 Description : REST API declaration
   4 Copyright   : (c) CNRS, 2017-Present
   5 License     : AGPL + CECILL v3
   6 Maintainer  : team@gargantext.org
   7 Stability   : experimental
   8 Portability : POSIX
   9
  10 Main (RESTful) API of the instance Gargantext.
  11
  12 The Garg-API is typed to derive the documentation, the mock and tests.
  13
  14 This API is indeed typed in order to be able to derive both the server
  15 and the client sides.
  16
  17 The Garg-API-Monad enables:
  18   - Security (WIP)
  19   - Features (WIP)
  20   - Database connection (long term)
  21   - In Memory stack management (short term)
  22   - Logs (WIP)
  23
  24 Thanks to Yann Esposito for our discussions at the start and to Nicolas
  25 Pouillard (who mainly made it).
  26
  27 -}
  28
  29 {-# OPTIONS_GHC -fno-warn-name-shadowing #-}
  30
  31 {-# LANGUAGE ConstraintKinds      #-}
  32 {-# LANGUAGE TemplateHaskell      #-}
  33 {-# LANGUAGE TypeOperators        #-}
  34 {-# LANGUAGE KindSignatures       #-}
  35 {-# LANGUAGE ScopedTypeVariables  #-}
  36 {-# LANGUAGE TypeFamilies         #-}
  37 {-# LANGUAGE UndecidableInstances #-}
  38
  39 ---------------------------------------------------------------------
  40 module Gargantext.API
  41       where
  42 ---------------------------------------------------------------------
  43 import Control.Exception (finally)
  44 import Control.Lens
  45 import Control.Monad.Except (withExceptT)
  46 import Control.Monad.Reader (runReaderT)
  47 import Data.Aeson.Encode.Pretty (encodePretty)
  48 import Data.List (lookup)
  49 import Data.Swagger
  50 import Data.Text (Text)
  51 import Data.Text.Encoding (encodeUtf8)
  52 import Data.Validity
  53 import Data.Version (showVersion)
  54 import GHC.Base (Applicative)
  55 import GHC.Generics (D1, Meta (..), Rep, Generic)
  56 import GHC.TypeLits (AppendSymbol, Symbol)
  57 import Gargantext.API.Admin.Auth (AuthContext, auth)
  58 import Gargantext.API.Admin.FrontEnd (frontEndServer)
  59 import Gargantext.API.Admin.Settings
  60 import Gargantext.API.Ngrams (HasRepoSaver(..), saveRepo)
  61 import Gargantext.API.Prelude
  62 import Gargantext.API.Routes
  63 import Gargantext.Prelude
  64 import Network.HTTP.Types hiding (Query)
  65 import Network.Wai
  66 import Network.Wai (Request, requestHeaders)
  67 import Network.Wai.Handler.Warp hiding (defaultSettings)
  68 import Network.Wai.Middleware.Cors
  69 import Network.Wai.Middleware.RequestLogger
  70 import Servant
  71 import Servant.Auth.Server (AuthResult(..))
  72 import Servant.Auth.Swagger ()
  73 import Servant.Swagger
  74 import Servant.Swagger.UI
  75 import System.IO (FilePath)
  76 import qualified Data.ByteString.Lazy.Char8 as BL8
  77 import qualified Data.Text.IO               as T
  78 import qualified Paths_gargantext           as PG -- cabal magic build module
  79 import qualified Gargantext.API.Public      as Public
  80
  81
  82 data Mode = Dev | Mock | Prod
  83        deriving (Show, Read, Generic)
  84
  85 -- | startGargantext takes as parameters port number and Ini file.
  86 startGargantext :: Mode -> PortNumber -> FilePath -> IO ()
  87 startGargantext mode port file = do
  88   env <- newEnv port file
  89   portRouteInfo port
  90   app <- makeApp env
  91   mid <- makeDevMiddleware mode
  92   run port (mid app) `finally` stopGargantext env
  93
  94 portRouteInfo :: PortNumber -> IO ()
  95 portRouteInfo port = do
  96   T.putStrLn "      ----Main Routes-----      "
  97   T.putStrLn $ "http://localhost:" <> toUrlPiece port <> "/index.html"
  98   T.putStrLn $ "http://localhost:" <> toUrlPiece port <> "/swagger-ui"
  99
 100 -- TODO clean this Monad condition (more generic) ?
 101 stopGargantext :: HasRepoSaver env => env -> IO ()
 102 stopGargantext env = do
 103   T.putStrLn "----- Stopping gargantext -----"
 104   runReaderT saveRepo env
 105
 106 -- | Output generated @swagger.json@ file for the @'TodoAPI'@.
 107 swaggerWriteJSON :: IO ()
 108 swaggerWriteJSON = BL8.writeFile "swagger.json" (encodePretty swaggerDoc)
 109
 110 -- | Swagger Specifications
 111 swaggerDoc :: Swagger
 112 swaggerDoc = toSwagger (Proxy :: Proxy GargAPI)
 113   & info.title       .~ "Gargantext"
 114   & info.version     .~ (cs $ showVersion PG.version)
 115   -- & info.base_url     ?~ (URL "http://gargantext.org/")
 116   & info.description ?~ "REST API specifications"
 117   -- & tags             .~ Set.fromList [Tag "Garg" (Just "Main perations") Nothing]
 118   & applyTagsFor (subOperations (Proxy :: Proxy GargAPI)(Proxy :: Proxy GargAPI))
 119                  ["Gargantext" & description ?~ "Main operations"]
 120   & info.license     ?~ ("AGPLV3 (English) and CECILL (French)" & url ?~ URL urlLicence )
 121     where
 122         urlLicence = "https://gitlab.iscpif.fr/gargantext/haskell-gargantext/blob/master/LICENSE"
 123
 124 {-
 125 startGargantextMock :: PortNumber -> IO ()
 126 startGargantextMock port = do
 127   portRouteInfo port
 128   application <- makeMockApp . MockEnv $ FireWall False
 129   run port application
 130 -}
 131
 132 ----------------------------------------------------------------------
 133
 134 fireWall :: Applicative f => Request -> FireWall -> f Bool
 135 fireWall req fw = do
 136     let origin = lookup "Origin" (requestHeaders req)
 137     let host   = lookup "Host"   (requestHeaders req)
 138
 139     if  origin == Just (encodeUtf8 "http://localhost:8008")
 140        && host == Just (encodeUtf8 "localhost:3000")
 141        || (not $ unFireWall fw)
 142
 143        then pure True
 144        else pure False
 145
 146 {-
 147 -- makeMockApp :: Env -> IO (Warp.Settings, Application)
 148 makeMockApp :: MockEnv -> IO Application
 149 makeMockApp env = do
 150     let serverApp = appMock
 151
 152     -- logWare <- mkRequestLogger def { destination = RequestLogger.Logger $ env^.logger }
 153     --logWare <- mkRequestLogger def { destination = RequestLogger.Logger "/tmp/logs.txt" }
 154     let checkOriginAndHost app req resp = do
 155             blocking <- fireWall req (env ^. menv_firewall)
 156             case blocking  of
 157                 True  -> app req resp
 158                 False -> resp ( responseLBS status401 []
 159                               "Invalid Origin or Host header")
 160
 161     let corsMiddleware = cors $ \_ -> Just CorsResourcePolicy
 162 --          { corsOrigins        = Just ([env^.settings.allowedOrigin], False)
 163             { corsOrigins        = Nothing --  == /*
 164             , corsMethods        = [ methodGet   , methodPost   , methodPut
 165                                    , methodDelete, methodOptions, methodHead]
 166             , corsRequestHeaders = ["authorization", "content-type"]
 167             , corsExposedHeaders = Nothing
 168             , corsMaxAge         = Just ( 60*60*24 ) -- one day
 169             , corsVaryOrigin     = False
 170             , corsRequireOrigin  = False
 171             , corsIgnoreFailures = False
 172             }
 173
 174     --let warpS = Warp.setPort (8008 :: Int)   -- (env^.settings.appPort)
 175     --          $ Warp.defaultSettings
 176
 177     --pure (warpS, logWare $ checkOriginAndHost $ corsMiddleware $ serverApp)
 178     pure $ logStdoutDev $ checkOriginAndHost $ corsMiddleware $ serverApp
 179 -}
 180
 181
 182 makeDevMiddleware :: Mode -> IO Middleware
 183 makeDevMiddleware mode = do
 184 -- logWare <- mkRequestLogger def { destination = RequestLogger.Logger $ env^.logger }
 185 -- logWare <- mkRequestLogger def { destination = RequestLogger.Logger "/tmp/logs.txt" }
 186 --    let checkOriginAndHost app req resp = do
 187 --            blocking <- fireWall req (env ^. menv_firewall)
 188 --            case blocking  of
 189 --                True  -> app req resp
 190 --                False -> resp ( responseLBS status401 []
 191 --                              "Invalid Origin or Host header")
 192 --
 193     let corsMiddleware = cors $ \_ -> Just CorsResourcePolicy
 194 --          { corsOrigins        = Just ([env^.settings.allowedOrigin], False)
 195             { corsOrigins        = Nothing --  == /*
 196             , corsMethods        = [ methodGet   , methodPost   , methodPut
 197                                    , methodDelete, methodOptions, methodHead]
 198             , corsRequestHeaders = ["authorization", "content-type"]
 199             , corsExposedHeaders = Nothing
 200             , corsMaxAge         = Just ( 60*60*24 ) -- one day
 201             , corsVaryOrigin     = False
 202             , corsRequireOrigin  = False
 203             , corsIgnoreFailures = False
 204             }
 205
 206     --let warpS = Warp.setPort (8008 :: Int)   -- (env^.settings.appPort)
 207     --          $ Warp.defaultSettings
 208
 209     --pure (warpS, logWare . checkOriginAndHost . corsMiddleware)
 210     case mode of
 211       Prod -> pure $ logStdout . corsMiddleware
 212       _    -> pure $ logStdoutDev . corsMiddleware
 213
 214 ---------------------------------------------------------------------
 215 -- | API Global
 216 ---------------------------------------------------------------------
 217 -- | Server declarations
 218 server :: forall env. EnvC env => env -> IO (Server API)
 219 server env = do
 220   -- orchestrator <- scrapyOrchestrator env
 221   pure $  schemaUiServer swaggerDoc
 222      :<|> hoistServerWithContext
 223             (Proxy :: Proxy GargAPI)
 224             (Proxy :: Proxy AuthContext)
 225             transform
 226             serverGargAPI
 227      :<|> frontEndServer
 228   where
 229     transform :: forall a. GargServerM env GargError a -> Handler a
 230     transform = Handler . withExceptT showAsServantErr . (`runReaderT` env)
 231
 232 showAsServantErr :: GargError -> ServerError
 233 showAsServantErr (GargServerError err) = err
 234 showAsServantErr a = err500 { errBody = BL8.pack $ show a }
 235
 236 ---------------------------
 237
 238 serverGargAPI :: GargServerT env err (GargServerM env err) GargAPI
 239 serverGargAPI -- orchestrator
 240        =  auth
 241      :<|> gargVersion
 242      :<|> serverPrivateGargAPI
 243      :<|> Public.api
 244
 245   --   :<|> orchestrator
 246   where
 247
 248     gargVersion :: GargServer GargVersion
 249     gargVersion = pure (cs $ showVersion PG.version)
 250
 251     serverPrivateGargAPI :: GargServerT env err (GargServerM env err) GargPrivateAPI
 252     serverPrivateGargAPI (Authenticated auser) = serverPrivateGargAPI' auser
 253     serverPrivateGargAPI _                     = throwAll' (_ServerError # err401)
 254 -- Here throwAll' requires a concrete type for the monad.
 255
 256
 257 -- TODO-SECURITY admin only: withAdmin
 258 -- Question: How do we mark admins?
 259 {-
 260 serverGargAdminAPI :: GargServer GargAdminAPI
 261 serverGargAdminAPI =  roots
 262                  :<|> nodesAPI
 263 -}
 264
 265 ---------------------------------------------------------------------
 266 --gargMock :: Server GargAPI
 267 --gargMock = mock apiGarg Proxy
 268 ---------------------------------------------------------------------
 269 makeApp :: EnvC env => env -> IO Application
 270 makeApp env = serveWithContext api cfg <$> server env
 271   where
 272     cfg :: Servant.Context AuthContext
 273     cfg = env ^. settings . jwtSettings
 274        :. env ^. settings . cookieSettings
 275     -- :. authCheck env
 276        :. EmptyContext
 277
 278 --appMock :: Application
 279 --appMock = serve api (swaggerFront :<|> gargMock :<|> serverStatic)
 280 ---------------------------------------------------------------------
 281 api :: Proxy API
 282 api  = Proxy
 283
 284 apiGarg :: Proxy GargAPI
 285 apiGarg  = Proxy
 286 ---------------------------------------------------------------------
 287 schemaUiServer :: (Server api ~ Handler Swagger)
 288         => Swagger -> Server (SwaggerSchemaUI' dir api)
 289 schemaUiServer = swaggerSchemaUIServer
 290
 291 ---------------------------------------------------------------------
 292 -- Type Family for the Documentation
 293 type family TypeName (x :: *) :: Symbol where
 294     TypeName Int  = "Int"
 295     TypeName Text = "Text"
 296     TypeName x    = GenericTypeName x (Rep x ())
 297
 298 type family GenericTypeName t (r :: *) :: Symbol where
 299     GenericTypeName t (D1 ('MetaData name mod pkg nt) f x) = name
 300
 301 type Desc t n = Description (AppendSymbol (TypeName t) (AppendSymbol " | " n))
 302
 303