src/Gargantext/API/Routes.hs

   1 {-|
   2 Module      : Gargantext.API.Routes
   3 Description :
   4 Copyright   : (c) CNRS, 2017-Present
   5 License     : AGPL + CECILL v3
   6 Maintainer  : team@gargantext.org
   7 Stability   : experimental
   8 Portability : POSIX
   9
  10
  11 -}
  12
  13 {-# OPTIONS_GHC -fno-warn-name-shadowing #-}
  14
  15 {-# LANGUAGE ConstraintKinds      #-}
  16 {-# LANGUAGE TemplateHaskell      #-}
  17 {-# LANGUAGE TypeOperators        #-}
  18 {-# LANGUAGE KindSignatures       #-}
  19 {-# LANGUAGE ScopedTypeVariables  #-}
  20 {-# LANGUAGE TypeFamilies         #-}
  21 {-# LANGUAGE UndecidableInstances #-}
  22
  23 ---------------------------------------------------------------------
  24 module Gargantext.API.Routes
  25       where
  26 ---------------------------------------------------------------------
  27 import Control.Concurrent (threadDelay)
  28 import Data.Text (Text)
  29 import Data.Validity
  30 import Gargantext.API.Admin.Auth (AuthRequest, AuthResponse, AuthenticatedUser(..), withAccess, PathId(..))
  31 import Gargantext.API.Admin.FrontEnd (FrontEndAPI)
  32 import Gargantext.API.Prelude
  33 import Gargantext.API.Count  (CountAPI, count, Query)
  34 import Gargantext.API.Ngrams (TableNgramsApi, apiNgramsTableDoc)
  35 import Gargantext.API.Node
  36 import Gargantext.API.Search (SearchPairsAPI, searchPairs)
  37 import Gargantext.Core.Types.Individu (User(..))
  38 import Gargantext.Database.Query.Table.Node.Contact (HyperdataContact)
  39 import Gargantext.Database.Admin.Types.Node
  40 import Gargantext.Database.Admin.Types.Node (NodeId, CorpusId, AnnuaireId)
  41 import Gargantext.Prelude
  42 import Gargantext.Viz.Graph.API
  43 import Servant
  44 import Servant.Auth as SA
  45 import Servant.Auth.Swagger ()
  46 import Servant.Job.Async
  47 import Servant.Swagger.UI
  48 import qualified Gargantext.API.Node.Corpus.Annuaire  as Annuaire
  49 import qualified Gargantext.API.Node.Corpus.Export    as Export
  50 import qualified Gargantext.API.Node.Corpus.New       as New
  51 import qualified Gargantext.API.Ngrams.List      as List
  52
  53
  54
  55 type GargAPI = "api" :> Summary "API " :> GargAPIVersion
  56 -- | TODO          :<|> Summary "Latest API" :> GargAPI'
  57
  58
  59 type GargAPIVersion = "v1.0"
  60                    :> Summary "Garg API Version "
  61                    :> GargAPI'
  62
  63 type GargVersion = "version"
  64                  :> Summary "Backend version"
  65                  :> Get '[JSON] Text
  66
  67 type GargAPI' =
  68            -- Auth endpoint
  69                 "auth"  :> Summary "AUTH API"
  70                         :> ReqBody '[JSON] AuthRequest
  71                         :> Post    '[JSON] AuthResponse
  72           :<|> GargVersion
  73                    -- TODO-ACCESS here we want to request a particular header for
  74            -- auth and capabilities.
  75           :<|> GargPrivateAPI
  76
  77
  78 type GargPrivateAPI = SA.Auth '[SA.JWT, SA.Cookie] AuthenticatedUser :> GargPrivateAPI'
  79
  80 type GargAdminAPI
  81               -- Roots endpoint
  82              =  "user"  :> Summary "First user endpoint"
  83                         :> Roots
  84            :<|> "nodes" :> Summary "Nodes endpoint"
  85                         :> ReqBody '[JSON] [NodeId] :> NodesAPI
  86
  87 type GargPrivateAPI' =
  88                 GargAdminAPI
  89
  90            -- Node endpoint
  91            :<|> "node"     :> Summary "Node endpoint"
  92                            :> Capture "node_id" NodeId
  93                            :> NodeAPI HyperdataAny
  94
  95            -- Corpus endpoints
  96            :<|> "corpus"   :> Summary "Corpus endpoint"
  97                            :> Capture "corpus_id" CorpusId
  98                            :> NodeAPI HyperdataCorpus
  99
 100            :<|> "corpus"   :> Summary "Corpus endpoint"
 101                            :> Capture "node1_id" NodeId
 102                            :> "document"
 103                            :> Capture "node2_id" NodeId
 104                            :> NodeNodeAPI HyperdataAny
 105
 106            :<|> "corpus"   :> Capture "node_id" CorpusId
 107                            :> Export.API
 108
 109            -- Annuaire endpoint
 110            :<|> "annuaire" :> Summary "Annuaire endpoint"
 111                            :> Capture "annuaire_id" AnnuaireId
 112                            :> NodeAPI HyperdataAnnuaire
 113
 114            :<|> "annuaire" :> Summary "Contact endpoint"
 115                            :> Capture "annuaire_id" NodeId
 116                            :> "contact"
 117                            :> Capture "contact_id" NodeId
 118                            :> NodeNodeAPI HyperdataContact
 119
 120            -- Document endpoint
 121            :<|> "document" :> Summary "Document endpoint"
 122                            :> Capture "doc_id" DocId
 123                            :> "ngrams" :> TableNgramsApi
 124
 125         -- :<|> "counts" :> Stream GET NewLineFraming '[JSON] Count :> CountAPI
 126             -- TODO-SECURITY
 127            :<|> "count"    :> Summary "Count endpoint"
 128                            :> ReqBody '[JSON] Query
 129                            :> CountAPI
 130
 131            -- Corpus endpoint --> TODO rename s/search/filter/g
 132            :<|> "search"   :> Capture "corpus" NodeId
 133                            :> SearchPairsAPI
 134
 135            -- TODO move to NodeAPI?
 136            :<|> "graph"    :> Summary "Graph endpoint"
 137                            :> Capture "graph_id" NodeId
 138                            :> GraphAPI
 139
 140            -- TODO move to NodeAPI?
 141            -- Tree endpoint
 142            :<|> "tree"    :> Summary "Tree endpoint"
 143                           :> Capture "tree_id" NodeId
 144                           :> TreeAPI
 145
 146            -- :<|> New.Upload
 147            :<|> New.AddWithForm
 148            :<|> New.AddWithQuery
 149
 150            -- :<|> "annuaire" :> Annuaire.AddWithForm
 151            -- :<|> New.AddWithFile
 152        --  :<|> "scraper" :> WithCallbacks ScraperAPI
 153        --  :<|> "new"  :> New.Api
 154
 155            :<|> "lists"  :> Summary "List export API"
 156                          :> Capture "listId" ListId
 157                          :> List.API
 158
 159            :<|> "wait"   :> Summary "Wait test"
 160                          :> Capture "x" Int
 161                          :> WaitAPI -- Get '[JSON] Int
 162
 163 -- /mv/<id>/<id>
 164 -- /merge/<id>/<id>
 165 -- /rename/<id>
 166        -- :<|> "static"
 167        -- :<|> "list"     :> Capture "node_id" Int  :> NodeAPI
 168        -- :<|> "ngrams"   :> Capture "node_id" Int  :> NodeAPI
 169        -- :<|> "auth"     :> Capture "node_id" Int  :> NodeAPI
 170 ---------------------------------------------------------------------
 171
 172 type API = SwaggerAPI
 173        :<|> GargAPI
 174        :<|> FrontEndAPI
 175
 176 -- | API for serving @swagger.json@
 177 type SwaggerAPI = SwaggerSchemaUI "swagger-ui" "swagger.json"
 178
 179 -- | API for serving main operational routes of @gargantext.org@
 180 -- TODO
 181 -- /mv/<id>/<id>
 182 -- /merge/<id>/<id>
 183 -- /rename/<id>
 184        -- :<|> "static"
 185        -- :<|> "list"     :> Capture "node_id" Int  :> NodeAPI
 186        -- :<|> "ngrams"   :> Capture "node_id" Int  :> NodeAPI
 187        -- :<|> "auth"     :> Capture "node_id" Int  :> NodeAPI
 188 ---------------------------------------------------------------------
 189
 190 ---------------------------------------------------------------------
 191 -- | Server declarations
 192
 193 -- TODO-SECURITY admin only: withAdmin
 194 -- Question: How do we mark admins?
 195 serverGargAdminAPI :: GargServer GargAdminAPI
 196 serverGargAdminAPI =  roots
 197                  :<|> nodesAPI
 198
 199
 200 serverPrivateGargAPI' :: AuthenticatedUser -> GargServer GargPrivateAPI'
 201 serverPrivateGargAPI' (AuthenticatedUser (NodeId uid))
 202        =  serverGargAdminAPI
 203      :<|> nodeAPI     (Proxy :: Proxy HyperdataAny)      uid
 204      :<|> nodeAPI     (Proxy :: Proxy HyperdataCorpus)   uid
 205      :<|> nodeNodeAPI (Proxy :: Proxy HyperdataAny)      uid
 206      :<|> Export.getCorpus   -- uid
 207      :<|> nodeAPI     (Proxy :: Proxy HyperdataAnnuaire) uid
 208      :<|> nodeNodeAPI (Proxy :: Proxy HyperdataContact)  uid
 209
 210      :<|> withAccess  (Proxy :: Proxy TableNgramsApi) Proxy uid
 211           <$> PathNode <*> apiNgramsTableDoc
 212
 213      :<|> count -- TODO: undefined
 214
 215      :<|> withAccess (Proxy :: Proxy SearchPairsAPI) Proxy uid
 216           <$> PathNode <*> searchPairs -- TODO: move elsewhere
 217
 218      :<|> withAccess (Proxy :: Proxy GraphAPI)       Proxy uid
 219           <$> PathNode <*> graphAPI uid -- TODO: mock
 220
 221      :<|> withAccess (Proxy :: Proxy TreeAPI)        Proxy uid
 222           <$> PathNode <*> treeAPI
 223      -- TODO access
 224      :<|> addCorpusWithForm  (UserDBId uid)
 225      :<|> addCorpusWithQuery (RootId   (NodeId uid))
 226
 227      -- :<|> addAnnuaireWithForm
 228      -- :<|> New.api  uid -- TODO-SECURITY
 229      -- :<|> New.info uid -- TODO-SECURITY
 230      :<|> List.api
 231      :<|> waitAPI
 232
 233
 234 ----------------------------------------------------------------------
 235 -- For Tests
 236 type WaitAPI = Get '[JSON] Text
 237
 238 waitAPI ::  Int -> GargServer WaitAPI
 239 waitAPI n = do
 240   let
 241     m = (10 :: Int) ^ (6 :: Int)
 242   _ <- liftBase $ threadDelay ( m * n)
 243   pure $ "Waited: " <> (cs $ show n)
 244 ----------------------------------------
 245
 246
 247 addCorpusWithQuery :: User -> GargServer New.AddWithQuery
 248 addCorpusWithQuery user cid =
 249   serveJobsAPI $
 250     JobFunction (\q log ->
 251       let
 252         log' x = do
 253           printDebug "addToCorpusWithQuery" x
 254           liftBase $ log x
 255       in New.addToCorpusWithQuery user cid q log'
 256       )
 257
 258 {-
 259 addWithFile :: GargServer New.AddWithFile
 260 addWithFile cid i f =
 261   serveJobsAPI $
 262     JobFunction (\_i log -> New.addToCorpusWithFile cid i f (liftBase . log))
 263 -}
 264
 265 addCorpusWithForm :: User -> GargServer New.AddWithForm
 266 addCorpusWithForm user cid =
 267   serveJobsAPI $
 268     JobFunction (\i log ->
 269       let
 270         log' x = do
 271           printDebug "addToCorpusWithForm" x
 272           liftBase $ log x
 273       in New.addToCorpusWithForm user cid i log')
 274
 275 addAnnuaireWithForm :: GargServer Annuaire.AddWithForm
 276 addAnnuaireWithForm cid =
 277   serveJobsAPI $
 278     JobFunction (\i log -> Annuaire.addToAnnuaireWithForm cid i (liftBase . log))
 279