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
  80
  81 data Mode = Dev | Mock | Prod
  82        deriving (Show, Read, Generic)
  83
  84 -- | startGargantext takes as parameters port number and Ini file.
  85 startGargantext :: Mode -> PortNumber -> FilePath -> IO ()
  86 startGargantext mode port file = do
  87   env <- newEnv port file
  88   portRouteInfo port
  89   app <- makeApp env
  90   mid <- makeDevMiddleware mode
  91   run port (mid app) `finally` stopGargantext env
  92
  93 portRouteInfo :: PortNumber -> IO ()
  94 portRouteInfo port = do
  95   T.putStrLn "      ----Main Routes-----      "
  96   T.putStrLn $ "http://localhost:" <> toUrlPiece port <> "/index.html"
  97   T.putStrLn $ "http://localhost:" <> toUrlPiece port <> "/swagger-ui"
  98
  99 -- TODO clean this Monad condition (more generic) ?
 100 stopGargantext :: HasRepoSaver env => env -> IO ()
 101 stopGargantext env = do
 102   T.putStrLn "----- Stopping gargantext -----"
 103   runReaderT saveRepo env
 104
 105 -- | Output generated @swagger.json@ file for the @'TodoAPI'@.
 106 swaggerWriteJSON :: IO ()
 107 swaggerWriteJSON = BL8.writeFile "swagger.json" (encodePretty swaggerDoc)
 108
 109 -- | Swagger Specifications
 110 swaggerDoc :: Swagger
 111 swaggerDoc = toSwagger (Proxy :: Proxy GargAPI)
 112   & info.title       .~ "Gargantext"
 113   & info.version     .~ (cs $ showVersion PG.version)
 114   -- & info.base_url     ?~ (URL "http://gargantext.org/")
 115   & info.description ?~ "REST API specifications"
 116   -- & tags             .~ Set.fromList [Tag "Garg" (Just "Main perations") Nothing]
 117   & applyTagsFor (subOperations (Proxy :: Proxy GargAPI)(Proxy :: Proxy GargAPI))
 118                  ["Gargantext" & description ?~ "Main operations"]
 119   & info.license     ?~ ("AGPLV3 (English) and CECILL (French)" & url ?~ URL urlLicence )
 120     where
 121         urlLicence = "https://gitlab.iscpif.fr/gargantext/haskell-gargantext/blob/master/LICENSE"
 122
 123 {-
 124 startGargantextMock :: PortNumber -> IO ()
 125 startGargantextMock port = do
 126   portRouteInfo port
 127   application <- makeMockApp . MockEnv $ FireWall False
 128   run port application
 129 -}
 130
 131 ----------------------------------------------------------------------
 132
 133 fireWall :: Applicative f => Request -> FireWall -> f Bool
 134 fireWall req fw = do
 135     let origin = lookup "Origin" (requestHeaders req)
 136     let host   = lookup "Host"   (requestHeaders req)
 137
 138     if  origin == Just (encodeUtf8 "http://localhost:8008")
 139        && host == Just (encodeUtf8 "localhost:3000")
 140        || (not $ unFireWall fw)
 141
 142        then pure True
 143        else pure False
 144
 145 {-
 146 -- makeMockApp :: Env -> IO (Warp.Settings, Application)
 147 makeMockApp :: MockEnv -> IO Application
 148 makeMockApp env = do
 149     let serverApp = appMock
 150
 151     -- logWare <- mkRequestLogger def { destination = RequestLogger.Logger $ env^.logger }
 152     --logWare <- mkRequestLogger def { destination = RequestLogger.Logger "/tmp/logs.txt" }
 153     let checkOriginAndHost app req resp = do
 154             blocking <- fireWall req (env ^. menv_firewall)
 155             case blocking  of
 156                 True  -> app req resp
 157                 False -> resp ( responseLBS status401 []
 158                               "Invalid Origin or Host header")
 159
 160     let corsMiddleware = cors $ \_ -> Just CorsResourcePolicy
 161 --          { corsOrigins        = Just ([env^.settings.allowedOrigin], False)
 162             { corsOrigins        = Nothing --  == /*
 163             , corsMethods        = [ methodGet   , methodPost   , methodPut
 164                                    , methodDelete, methodOptions, methodHead]
 165             , corsRequestHeaders = ["authorization", "content-type"]
 166             , corsExposedHeaders = Nothing
 167             , corsMaxAge         = Just ( 60*60*24 ) -- one day
 168             , corsVaryOrigin     = False
 169             , corsRequireOrigin  = False
 170             , corsIgnoreFailures = False
 171             }
 172
 173     --let warpS = Warp.setPort (8008 :: Int)   -- (env^.settings.appPort)
 174     --          $ Warp.defaultSettings
 175
 176     --pure (warpS, logWare $ checkOriginAndHost $ corsMiddleware $ serverApp)
 177     pure $ logStdoutDev $ checkOriginAndHost $ corsMiddleware $ serverApp
 178 -}
 179
 180
 181 makeDevMiddleware :: Mode -> IO Middleware
 182 makeDevMiddleware mode = do
 183
 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   --   :<|> orchestrator
 244   where
 245
 246     gargVersion :: GargServer GargVersion
 247     gargVersion = pure (cs $ showVersion PG.version)
 248
 249     serverPrivateGargAPI :: GargServerT env err (GargServerM env err) GargPrivateAPI
 250     serverPrivateGargAPI (Authenticated auser) = serverPrivateGargAPI' auser
 251     serverPrivateGargAPI _                     = throwAll' (_ServerError # err401)
 252 -- Here throwAll' requires a concrete type for the monad.
 253
 254
 255 -- TODO-SECURITY admin only: withAdmin
 256 -- Question: How do we mark admins?
 257 {-
 258 serverGargAdminAPI :: GargServer GargAdminAPI
 259 serverGargAdminAPI =  roots
 260                  :<|> nodesAPI
 261 -}
 262
 263 ---------------------------------------------------------------------
 264 --gargMock :: Server GargAPI
 265 --gargMock = mock apiGarg Proxy
 266 ---------------------------------------------------------------------
 267 makeApp :: EnvC env => env -> IO Application
 268 makeApp env = serveWithContext api cfg <$> server env
 269   where
 270     cfg :: Servant.Context AuthContext
 271     cfg = env ^. settings . jwtSettings
 272        :. env ^. settings . cookieSettings
 273     -- :. authCheck env
 274        :. EmptyContext
 275
 276 --appMock :: Application
 277 --appMock = serve api (swaggerFront :<|> gargMock :<|> serverStatic)
 278 ---------------------------------------------------------------------
 279 api :: Proxy API
 280 api  = Proxy
 281
 282 apiGarg :: Proxy GargAPI
 283 apiGarg  = Proxy
 284 ---------------------------------------------------------------------
 285 schemaUiServer :: (Server api ~ Handler Swagger)
 286         => Swagger -> Server (SwaggerSchemaUI' dir api)
 287 schemaUiServer = swaggerSchemaUIServer
 288
 289 ---------------------------------------------------------------------
 290 -- Type Family for the Documentation
 291 type family TypeName (x :: *) :: Symbol where
 292     TypeName Int  = "Int"
 293     TypeName Text = "Text"
 294     TypeName x    = GenericTypeName x (Rep x ())
 295
 296 type family GenericTypeName t (r :: *) :: Symbol where
 297     GenericTypeName t (D1 ('MetaData name mod pkg nt) f x) = name
 298
 299 type Desc t n = Description (AppendSymbol (TypeName t) (AppendSymbol " | " n))
 300
 301