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 {-# LANGUAGE ConstraintKinds      #-}
  13 {-# LANGUAGE TypeOperators        #-}
  14 {-# LANGUAGE KindSignatures       #-}
  15 {-# LANGUAGE ScopedTypeVariables  #-}
  16 {-# LANGUAGE TypeFamilies         #-}
  17
  18 module Gargantext.API.Routes
  19       where
  20
  21 import Control.Concurrent (threadDelay)
  22 import Control.Lens (view)
  23 import Data.Text (Text)
  24 import Data.Validity
  25 import Servant
  26 import Servant.Auth as SA
  27 import Servant.Auth.Swagger ()
  28 import Servant.Swagger.UI
  29
  30 import Gargantext.API.Admin.Auth (ForgotPasswordAPI, ForgotPasswordAsyncAPI, withAccess)
  31 import Gargantext.API.Admin.Auth.Types (AuthRequest, AuthResponse, AuthenticatedUser(..), PathId(..))
  32 import Gargantext.API.Admin.EnvTypes (Env, GargJob(..))
  33 import Gargantext.API.Admin.FrontEnd (FrontEndAPI)
  34 import Gargantext.API.Context
  35 import Gargantext.API.Count  (CountAPI, count, Query)
  36 import Gargantext.API.Members (MembersAPI, members)
  37 import Gargantext.API.Ngrams (TableNgramsApi, apiNgramsTableDoc)
  38 import Gargantext.API.Node
  39 import Gargantext.API.Prelude
  40 import Gargantext.Core.Types.Individu (User(..))
  41 import Gargantext.Core.Viz.Graph.API
  42 import Gargantext.Database.Admin.Types.Hyperdata
  43 import Gargantext.Database.Admin.Types.Node
  44 import Gargantext.Database.Prelude (HasConfig(..))
  45 import Gargantext.Prelude
  46 import Gargantext.Prelude.Config (gc_max_docs_scrapers)
  47 import Gargantext.Utils.Jobs (serveJobsAPI, MonadJobStatus(..))
  48 import qualified Gargantext.API.GraphQL                    as GraphQL
  49 import qualified Gargantext.API.Ngrams.List                as List
  50 import qualified Gargantext.API.Node.Contact               as Contact
  51 import qualified Gargantext.API.Node.Corpus.Annuaire       as Annuaire
  52 import qualified Gargantext.API.Node.Corpus.Export         as CorpusExport
  53 import qualified Gargantext.API.Node.Corpus.Export.Types   as CorpusExport
  54 import qualified Gargantext.API.Node.Corpus.New            as New
  55 import qualified Gargantext.API.Node.Document.Export       as DocumentExport
  56 import qualified Gargantext.API.Node.Document.Export.Types as DocumentExport
  57 import qualified Gargantext.API.Public                     as Public
  58
  59
  60 type GargAPI = "api" :> Summary "API " :> GargAPIVersion
  61 --- | TODO          :<|> Summary "Latest API" :> GargAPI'
  62
  63 type GargAPIVersion = "v1.0"
  64                    :> Summary "Garg API Version "
  65                    :> GargAPI'
  66
  67 type GargVersion = "version"
  68                  :> Summary "Backend version"
  69                  :> Get '[JSON] Text
  70
  71 type GargAPI' =
  72            -- Auth endpoint
  73                 "auth"  :> Summary "AUTH API"
  74                         :> ReqBody '[JSON] AuthRequest
  75                         :> Post    '[JSON] AuthResponse
  76           :<|> "forgot-password" :> ForgotPasswordAPI
  77           :<|> "async" :> "forgot-password" :> ForgotPasswordAsyncAPI
  78           :<|> GargVersion
  79                    -- TODO-ACCESS here we want to request a particular header for
  80            -- auth and capabilities.
  81           :<|> GargPrivateAPI
  82           :<|> "public"      :> Public.API
  83
  84
  85 type GargPrivateAPI = SA.Auth '[SA.JWT, SA.Cookie] AuthenticatedUser
  86                     :> GargPrivateAPI'
  87
  88 type GargAdminAPI
  89               -- Roots endpoint
  90              =  "user"  :> Summary "First user endpoint"
  91                         :> Roots
  92            :<|> "nodes" :> Summary "Nodes endpoint"
  93                         :> ReqBody '[JSON] [NodeId] :> NodesAPI
  94
  95 type GargPrivateAPI' =
  96                 GargAdminAPI
  97
  98            -- Node endpoint
  99            :<|> "node"     :> Summary "Node endpoint"
 100                            :> Capture "node_id" NodeId
 101                            :> NodeAPI HyperdataAny
 102
 103            -- Context endpoint
 104            :<|> "context"  :> Summary "Node endpoint"
 105                            :> Capture "node_id" ContextId
 106                            :> ContextAPI HyperdataAny
 107
 108            -- Corpus endpoints
 109            :<|> "corpus"   :> Summary "Corpus endpoint"
 110                            :> Capture "corpus_id" CorpusId
 111                            :> NodeAPI HyperdataCorpus
 112
 113            :<|> "corpus"   :> Summary "Corpus endpoint"
 114                            :> Capture "node1_id" NodeId
 115                            :> "document"
 116                            :> Capture "node2_id" NodeId
 117                            :> NodeNodeAPI HyperdataAny
 118
 119            :<|> "corpus"   :> Capture "node_id" CorpusId
 120                            :> CorpusExport.API
 121
 122            -- Annuaire endpoint
 123 {-
 124            :<|> "contact"  :> Summary "Contact endpoint"
 125                            :> Capture "contact_id" ContactId
 126                            :> NodeAPI HyperdataContact
 127 --}
 128
 129            :<|> "annuaire" :> Summary "Annuaire endpoint"
 130                            :> Capture "annuaire_id" AnnuaireId
 131                            :> NodeAPI HyperdataAnnuaire
 132
 133            :<|> "annuaire" :> Summary "Contact endpoint"
 134                            :> Capture "annuaire_id" NodeId
 135                            :> Contact.API
 136            -- Document endpoint
 137            :<|> "document" :> Summary "Document endpoint"
 138                            :> Capture "doc_id" DocId
 139                            :> "ngrams"
 140                            :> TableNgramsApi
 141
 142            :<|> "texts" :> Capture "node_id" DocId
 143                            :> DocumentExport.API
 144
 145         -- :<|> "counts" :> Stream GET NewLineFraming '[JSON] Count :> CountAPI
 146             -- TODO-SECURITY
 147            :<|> "count"    :> Summary "Count endpoint"
 148                            :> ReqBody '[JSON] Query
 149                            :> CountAPI
 150
 151            -- Corpus endpoint --> TODO rename s/search/filter/g
 152            -- :<|> "search"   :> Capture "corpus" NodeId
 153            --                 :> (Search.API Search.SearchResult)
 154
 155            -- TODO move to NodeAPI?
 156            :<|> "graph"    :> Summary "Graph endpoint"
 157                            :> Capture "graph_id" NodeId
 158                            :> GraphAPI
 159
 160            -- TODO move to NodeAPI?
 161            -- Tree endpoint
 162            :<|> "tree"    :> Summary "Tree endpoint"
 163                           :> Capture "tree_id" NodeId
 164                           :> TreeAPI
 165            -- Flat tree endpoint
 166            :<|> "treeflat" :> Summary "Flat tree endpoint"
 167                            :> Capture "tree_id" NodeId
 168                            :> TreeFlatAPI
 169
 170            :<|> "members" :> Summary "Team node members"
 171                           :> MembersAPI
 172
 173            -- :<|> New.Upload
 174            :<|> New.AddWithForm
 175 --           :<|> New.AddWithFile
 176            :<|> New.AddWithQuery
 177
 178            -- :<|> "annuaire" :> Annuaire.AddWithForm
 179            -- :<|> New.AddWithFile
 180        --  :<|> "scraper" :> WithCallbacks ScraperAPI
 181        --  :<|> "new"  :> New.Api
 182
 183       -- TODO refactor the 3 routes below
 184            :<|> List.GETAPI
 185            :<|> List.JSONAPI
 186            :<|> List.CSVAPI
 187 {-
 188            :<|> "wait"   :> Summary "Wait test"
 189                          :> Capture "x" Int
 190                          :> WaitAPI -- Get '[JSON] Int
 191 -}
 192 -- /mv/<id>/<id>
 193 -- /merge/<id>/<id>
 194 -- /rename/<id>
 195        -- :<|> "static"
 196        -- :<|> "list"     :> Capture "node_id" Int  :> NodeAPI
 197        -- :<|> "ngrams"   :> Capture "node_id" Int  :> NodeAPI
 198        -- :<|> "auth"     :> Capture "node_id" Int  :> NodeAPI
 199 ---------------------------------------------------------------------
 200
 201 type API = SwaggerAPI
 202        :<|> GargAPI
 203        :<|> GraphQL.API
 204        :<|> FrontEndAPI
 205
 206 -- | API for serving @swagger.json@
 207 type SwaggerAPI = SwaggerSchemaUI "swagger-ui" "swagger.json"
 208
 209 -- | API for serving main operational routes of @gargantext.org@
 210 -- TODO
 211 -- /mv/<id>/<id>
 212 -- /merge/<id>/<id>
 213 -- /rename/<id>
 214        -- :<|> "static"
 215        -- :<|> "list"     :> Capture "node_id" Int  :> NodeAPI
 216        -- :<|> "ngrams"   :> Capture "node_id" Int  :> NodeAPI
 217        -- :<|> "auth"     :> Capture "node_id" Int  :> NodeAPI
 218 ---------------------------------------------------------------------
 219
 220 ---------------------------------------------------------------------
 221 -- | Server declarations
 222
 223 -- TODO-SECURITY admin only: withAdmin
 224 -- Question: How do we mark admins?
 225 serverGargAdminAPI :: GargServer GargAdminAPI
 226 serverGargAdminAPI =  roots
 227                  :<|> nodesAPI
 228
 229
 230 serverPrivateGargAPI'
 231   :: AuthenticatedUser -> ServerT GargPrivateAPI' (GargM Env GargError)
 232 serverPrivateGargAPI' (AuthenticatedUser (NodeId uid))
 233        =  serverGargAdminAPI
 234      :<|> nodeAPI     (Proxy :: Proxy HyperdataAny)      uid
 235      :<|> contextAPI  (Proxy :: Proxy HyperdataAny)      uid
 236      :<|> nodeAPI     (Proxy :: Proxy HyperdataCorpus)   uid
 237      :<|> nodeNodeAPI (Proxy :: Proxy HyperdataAny)      uid
 238      :<|> CorpusExport.getCorpus   -- uid
 239  --    :<|> nodeAPI     (Proxy :: Proxy HyperdataContact)  uid
 240      :<|> nodeAPI     (Proxy :: Proxy HyperdataAnnuaire) uid
 241      :<|> Contact.api uid
 242
 243      :<|> withAccess  (Proxy :: Proxy TableNgramsApi) Proxy uid
 244           <$> PathNode <*> apiNgramsTableDoc
 245
 246      :<|> DocumentExport.api uid
 247
 248      :<|> count -- TODO: undefined
 249
 250      -- :<|> withAccess (Proxy :: Proxy (Search.API Search.SearchResult)) Proxy uid
 251      --     <$> PathNode <*> Search.api -- TODO: move elsewhere
 252
 253      :<|> withAccess (Proxy :: Proxy GraphAPI)       Proxy uid
 254           <$> PathNode <*> graphAPI uid -- TODO: mock
 255
 256      :<|> withAccess (Proxy :: Proxy TreeAPI)        Proxy uid
 257           <$> PathNode <*> treeAPI
 258
 259      :<|> withAccess (Proxy :: Proxy TreeFlatAPI)    Proxy uid
 260           <$> PathNode <*> treeFlatAPI
 261
 262      :<|> members uid
 263      -- TODO access
 264      :<|> addCorpusWithForm  (RootId (NodeId uid))
 265     -- :<|> addCorpusWithFile  (RootId (NodeId uid))
 266      :<|> addCorpusWithQuery (RootId (NodeId uid))
 267
 268      -- :<|> addAnnuaireWithForm
 269      -- :<|> New.api  uid -- TODO-SECURITY
 270      -- :<|> New.info uid -- TODO-SECURITY
 271      :<|> List.getApi
 272      :<|> List.jsonApi
 273      :<|> List.csvApi
 274 --     :<|> waitAPI
 275
 276
 277 ----------------------------------------------------------------------
 278 -- For Tests
 279 type WaitAPI = Get '[JSON] Text
 280
 281 waitAPI ::  Int -> GargServer WaitAPI
 282 waitAPI n = do
 283   let
 284     m = (10 :: Int) ^ (6 :: Int)
 285   _ <- liftBase $ threadDelay ( m * n)
 286   pure $ "Waited: " <> (cs $ show n)
 287 ----------------------------------------
 288
 289 addCorpusWithQuery :: User -> ServerT New.AddWithQuery (GargM Env GargError)
 290 addCorpusWithQuery user cid =
 291   serveJobsAPI AddCorpusQueryJob $ \jHandle q -> do
 292     limit <- view $ hasConfig . gc_max_docs_scrapers
 293     New.addToCorpusWithQuery user cid q (Just $ fromIntegral limit) jHandle
 294       {- let log' x = do
 295         printDebug "addToCorpusWithQuery" x
 296         liftBase $ log x
 297       -}
 298
 299 addCorpusWithForm :: User -> ServerT New.AddWithForm (GargM Env GargError)
 300 addCorpusWithForm user cid =
 301   serveJobsAPI AddCorpusFormJob $ \jHandle i -> do
 302     -- /NOTE(adinapoli)/ Track the initial steps outside 'addToCorpusWithForm', because it's
 303     -- called in a few places, and the job status might be different between invocations.
 304     markStarted 3 jHandle
 305     New.addToCorpusWithForm user cid i jHandle
 306
 307 addCorpusWithFile :: User -> ServerT New.AddWithFile (GargM Env GargError)
 308 addCorpusWithFile user cid =
 309   serveJobsAPI AddCorpusFileJob $ \jHandle i ->
 310     New.addToCorpusWithFile user cid i jHandle
 311
 312 addAnnuaireWithForm :: ServerT Annuaire.AddWithForm (GargM Env GargError)
 313 addAnnuaireWithForm cid =
 314   serveJobsAPI AddAnnuaireFormJob $ \jHandle i ->
 315     Annuaire.addToAnnuaireWithForm cid i jHandle