Stability : experimental
Portability : POSIX
+-- TODO-SECURITY: Critical
+
+-- TODO-ACCESS: CanGetNode
+-- TODO-EVENTS: No events as this is a read only query.
Node API
+-------------------------------------------------------------------
+-- TODO-ACCESS: access by admin only.
+-- At first let's just have an isAdmin check.
+-- Later: check userId CanDeleteNodes Nothing
+-- TODO-EVENTS: DeletedNodes [NodeId]
+-- {"tag": "DeletedNodes", "nodes": [Int*]}
+
-}
-{-# OPTIONS_GHC -fno-warn-name-shadowing -fno-warn-orphans #-}
+{-# OPTIONS_GHC -fno-warn-orphans #-}
-{-# LANGUAGE NoImplicitPrelude #-}
-{-# LANGUAGE DataKinds #-}
-{-# LANGUAGE TemplateHaskell #-}
-{-# LANGUAGE TypeOperators #-}
-{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE DataKinds #-}
+{-# LANGUAGE DeriveGeneric #-}
+{-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE FlexibleInstances #-}
+{-# LANGUAGE NoImplicitPrelude #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE RankNTypes #-}
+{-# LANGUAGE ScopedTypeVariables #-}
+{-# LANGUAGE TemplateHaskell #-}
+{-# LANGUAGE TypeOperators #-}
--------------------------------------------------------------------
module Gargantext.API.Node
- where
--------------------------------------------------------------------
+ where
-import Control.Lens (prism')
-import Control.Monad.IO.Class (liftIO)
-import Control.Monad ((>>))
---import System.IO (putStrLn, readFile)
-
-import Data.Aeson (Value())
---import Data.Text (Text(), pack)
+import Control.Lens ((^.))
+import Data.Aeson (FromJSON, ToJSON)
+import Data.Maybe
+import Data.Swagger
import Data.Text (Text())
import Data.Time (UTCTime)
+import GHC.Generics (Generic)
+import Gargantext.API.Auth (withAccess, PathId(..))
+import Gargantext.API.Metrics
+import Gargantext.API.Ngrams (TabType(..), TableNgramsApi, apiNgramsTableCorpus, QueryParamR)
+import Gargantext.API.Ngrams.NTree (MyTree)
+import Gargantext.API.Search (SearchDocsAPI, searchDocs, SearchPairsAPI, searchPairs)
+import Gargantext.API.Table
+import Gargantext.API.Types
+import Gargantext.Core.Types (NodeTableResult)
+import Gargantext.Core.Types.Main (Tree, NodeTree, ListType)
+import Gargantext.Database.Config (nodeTypeId)
+import Gargantext.Database.Flow.Pairing (pairing)
+import Gargantext.Database.Facet (FacetDoc, OrderBy(..))
+import Gargantext.Database.Node.Children (getChildren)
+import Gargantext.Database.Node.User (NodeUser)
+import Gargantext.Database.Schema.Node (getNodesWithParentId, getNodeWith, getNode, deleteNode, deleteNodes, mkNodeWithParent, JSONB, HasNodeError(..), getNodeUser)
+import Gargantext.Database.Schema.NodeNode -- (nodeNodesCategory, insertNodeNode, NodeNode(..))
+import Gargantext.Database.Node.UpdateOpaleye (updateHyperdata)
+import Gargantext.Database.Tree (treeDB)
+import Gargantext.Database.Types.Node
+import Gargantext.Database.Utils -- (Cmd, CmdM)
+import Gargantext.Prelude
+import Gargantext.Viz.Chart
+import Gargantext.Viz.Phylo.API (PhyloAPI, phyloAPI)
+import Servant
+import Test.QuickCheck (elements)
+import Test.QuickCheck.Arbitrary (Arbitrary, arbitrary)
+import qualified Gargantext.Database.Node.Update as U (update, Update(..))
-import Database.PostgreSQL.Simple (Connection)
+{-
+import qualified Gargantext.Text.List.Learn as Learn
+import qualified Data.Vector as Vec
+--}
-import Servant
--- import Servant.Multipart
+type NodesAPI = Delete '[JSON] Int
-import Gargantext.Prelude
-import Gargantext.Database.Types.Node
-import Gargantext.Database.Node ( getNodesWithParentId
- , getNode, getNodesWith
- , deleteNode, deleteNodes)
-import Gargantext.Database.Facet (FacetDoc, getDocFacet
- ,FacetChart)
-import Gargantext.Database.Tree (treeDB, HasTreeError(..), TreeError(..))
-
--- Graph
-import Gargantext.TextFlow
-import Gargantext.Viz.Graph (Graph)
-import Gargantext.Core (Lang(..))
-import Gargantext.Core.Types.Main (Tree, NodeTree)
-import Gargantext.Text.Terms (TermType(..))
--------------------------------------------------------------------
--------------------------------------------------------------------
--- | Node API Types management
-type Roots = Get '[JSON] [Node Value]
- :<|> Post '[JSON] Int -- TODO
+-- | Delete Nodes
+-- Be careful: really delete nodes
+-- Access by admin only
+nodesAPI :: [NodeId] -> GargServer NodesAPI
+nodesAPI ids = deleteNodes ids
+
+------------------------------------------------------------------------
+-- | TODO-ACCESS: access by admin only.
+-- At first let's just have an isAdmin check.
+-- Later: CanAccessAnyNode or (CanGetAnyNode, CanPutAnyNode)
+-- To manage the Users roots
+-- TODO-EVENTS:
+-- PutNode ?
+-- TODO needs design discussion.
+type Roots = Get '[JSON] [NodeUser]
:<|> Put '[JSON] Int -- TODO
- :<|> Delete '[JSON] Int -- TODO
-type NodesAPI = Delete '[JSON] Int
+-- | TODO: access by admin only
+roots :: GargServer Roots
+roots = getNodesWithParentId Nothing
+ :<|> pure (panic "not implemented yet") -- TODO use patch map to update what we need
-type NodeAPI = Get '[JSON] (Node Value)
- :<|> Post '[JSON] Int
- :<|> Put '[JSON] Int
+-------------------------------------------------------------------
+-- | Node API Types management
+-- TODO-ACCESS : access by users
+-- No ownership check is needed if we strictly follow the capability model.
+--
+-- CanGetNode (Node, Children, TableApi, TableNgramsApiGet, PairingApi, ChartApi,
+-- SearchAPI)
+-- CanRenameNode (or part of CanEditNode?)
+-- CanCreateChildren (PostNodeApi)
+-- CanEditNode / CanPutNode TODO not implemented yet
+-- CanDeleteNode
+-- CanPatch (TableNgramsApi)
+-- CanFavorite
+-- CanMoveToTrash
+
+type NodeAPI a = Get '[JSON] (Node a)
+ :<|> "rename" :> RenameApi
+ :<|> PostNodeApi -- TODO move to children POST
+ :<|> ReqBody '[JSON] a :> Put '[JSON] Int
:<|> Delete '[JSON] Int
- :<|> "children" :> Summary " Summary children"
- :> QueryParam "type" NodeType
- :> QueryParam "offset" Int
- :> QueryParam "limit" Int
- :> Get '[JSON] [Node Value]
- :<|> "facet" :> Summary " Facet documents"
- :> "documents" :> FacetDocAPI
--- :<|> "facet" :<|> "sources" :<|> FacetSourcesAPI
--- :<|> "facet" :<|> "authors" :<|> FacetAuthorsAPI
--- :<|> "facet" :<|> "terms" :<|> FacetTermsAPI
-
---data FacetFormat = Table | Chart
---data FacetType = Doc | Term | Source | Author
---data Facet = Facet Doc Format
-
-
-type FacetDocAPI = "table"
- :> Summary " Table data"
- :> QueryParam "offset" Int
- :> QueryParam "limit" Int
- :> Get '[JSON] [FacetDoc]
-
- :<|> "chart"
- :> Summary " Chart data"
- :> QueryParam "from" UTCTime
- :> QueryParam "to" UTCTime
- :> Get '[JSON] [FacetChart]
+ :<|> "children" :> ChildrenApi a
+
+ -- TODO gather it
+ :<|> "table" :> TableApi
+ :<|> "ngrams" :> TableNgramsApi
+
+ :<|> "category" :> CatApi
+ :<|> "search" :> SearchDocsAPI
+
+ -- Pairing utilities
+ :<|> "pairwith" :> PairWith
+ :<|> "pairs" :> Pairs
+ :<|> "pairing" :> PairingApi
+ :<|> "searchPair" :> SearchPairsAPI
+
+ -- VIZ
+ :<|> "metrics" :> ScatterAPI
+ :<|> "chart" :> ChartApi
+ :<|> "pie" :> PieApi
+ :<|> "tree" :> TreeApi
+ :<|> "phylo" :> PhyloAPI
+ -- :<|> "add" :> NodeAddAPI
+
+-- TODO-ACCESS: check userId CanRenameNode nodeId
+-- TODO-EVENTS: NodeRenamed RenameNode or re-use some more general NodeEdited...
+type RenameApi = Summary " Rename Node"
+ :> ReqBody '[JSON] RenameNode
+ :> Put '[JSON] [Int]
+
+type PostNodeApi = Summary " PostNode Node with ParentId as {id}"
+ :> ReqBody '[JSON] PostNode
+ :> Post '[JSON] [NodeId]
+
+type ChildrenApi a = Summary " Summary children"
+ :> QueryParam "type" NodeType
+ :> QueryParam "offset" Int
+ :> QueryParam "limit" Int
+ -- :> Get '[JSON] [Node a]
+ :> Get '[JSON] (NodeTableResult a)
+
+------------------------------------------------------------------------
+type NodeNodeAPI a = Get '[JSON] (Node a)
+
+nodeNodeAPI :: forall proxy a. (JSONB a, ToJSON a)
+ => proxy a
+ -> UserId
+ -> CorpusId
+ -> NodeId
+ -> GargServer (NodeNodeAPI a)
+nodeNodeAPI p uId cId nId = withAccess (Proxy :: Proxy (NodeNodeAPI a)) Proxy uId (PathNodeNode cId nId) nodeNodeAPI'
+ where
+ nodeNodeAPI' :: GargServer (NodeNodeAPI a)
+ nodeNodeAPI' = getNodeWith nId p
+
+------------------------------------------------------------------------
+-- TODO: make the NodeId type indexed by `a`, then we no longer need the proxy.
+nodeAPI :: forall proxy a. (JSONB a, FromJSON a, ToJSON a) => proxy a -> UserId -> NodeId -> GargServer (NodeAPI a)
+nodeAPI p uId id = withAccess (Proxy :: Proxy (NodeAPI a)) Proxy uId (PathNode id) nodeAPI'
+ where
+ nodeAPI' :: GargServer (NodeAPI a)
+ nodeAPI' = getNodeWith id p
+ :<|> rename id
+ :<|> postNode uId id
+ :<|> putNode id
+ :<|> deleteNodeApi id
+ :<|> getChildren id p
+
+ -- TODO gather it
+ :<|> tableApi id
+ :<|> apiNgramsTableCorpus id
+
+ :<|> catApi id
+
+ :<|> searchDocs id
+ -- Pairing Tools
+ :<|> pairWith id
+ :<|> pairs id
+ :<|> getPair id
+ :<|> searchPairs id
+
+ :<|> getScatter id
+ :<|> getChart id
+ :<|> getPie id
+ :<|> getTree id
+ :<|> phyloAPI id uId
+ -- :<|> nodeAddAPI id
+ -- :<|> postUpload id
+
+ deleteNodeApi id' = do
+ node <- getNode id'
+ if _node_typename node == nodeTypeId NodeUser
+ then panic "not allowed" -- TODO add proper Right Management Type
+ else deleteNode id'
+
+------------------------------------------------------------------------
+data RenameNode = RenameNode { r_name :: Text }
+ deriving (Generic)
+
+-- TODO unPrefix "r_" FromJSON, ToJSON, ToSchema, adapt frontend.
+instance FromJSON RenameNode
+instance ToJSON RenameNode
+instance ToSchema RenameNode
+instance Arbitrary RenameNode where
+ arbitrary = elements [RenameNode "test"]
+------------------------------------------------------------------------
+data PostNode = PostNode { pn_name :: Text
+ , pn_typename :: NodeType}
+ deriving (Generic)
+
+-- TODO unPrefix "pn_" FromJSON, ToJSON, ToSchema, adapt frontend.
+instance FromJSON PostNode
+instance ToJSON PostNode
+instance ToSchema PostNode
+instance Arbitrary PostNode where
+ arbitrary = elements [PostNode "Node test" NodeCorpus]
+
+------------------------------------------------------------------------
+type CatApi = Summary " To Categorize NodeNodes: 0 for delete, 1/null neutral, 2 favorite"
+ :> ReqBody '[JSON] NodesToCategory
+ :> Put '[JSON] [Int]
+
+data NodesToCategory = NodesToCategory { ntc_nodesId :: [NodeId]
+ , ntc_category :: Int
+ }
+ deriving (Generic)
+
+-- TODO unPrefix "ntc_" FromJSON, ToJSON, ToSchema, adapt frontend.
+instance FromJSON NodesToCategory
+instance ToJSON NodesToCategory
+instance ToSchema NodesToCategory
+
+catApi :: CorpusId -> GargServer CatApi
+catApi = putCat
+ where
+ putCat :: CorpusId -> NodesToCategory -> Cmd err [Int]
+ putCat cId cs' = nodeNodesCategory $ map (\n -> (cId, n, ntc_category cs')) (ntc_nodesId cs')
+
+------------------------------------------------------------------------
+-- TODO adapt FacetDoc -> ListDoc (and add type of document as column)
+-- Pairing utilities to move elsewhere
+type PairingApi = Summary " Pairing API"
+ :> QueryParam "view" TabType
+ -- TODO change TabType -> DocType (CorpusId for pairing)
+ :> QueryParam "offset" Int
+ :> QueryParam "limit" Int
+ :> QueryParam "order" OrderBy
+ :> Get '[JSON] [FacetDoc]
+
+----------
+type Pairs = Summary "List of Pairs"
+ :> Get '[JSON] [AnnuaireId]
+pairs :: CorpusId -> GargServer Pairs
+pairs cId = do
+ ns <- getNodeNode cId
+ pure $ map _nn_node2_id ns
+
+type PairWith = Summary "Pair a Corpus with an Annuaire"
+ :> "annuaire" :> Capture "annuaire_id" AnnuaireId
+ :> "list" :> Capture "list_id" ListId
+ :> Post '[JSON] Int
+
+pairWith :: CorpusId -> GargServer PairWith
+pairWith cId aId lId = do
+ r <- pairing cId aId lId
+ _ <- insertNodeNode [ NodeNode cId aId Nothing Nothing]
+ pure r
+
+------------------------------------------------------------------------
+type ChartApi = Summary " Chart API"
+ :> QueryParam "from" UTCTime
+ :> QueryParam "to" UTCTime
+ :> Get '[JSON] (ChartMetrics Histo)
+
+type PieApi = Summary " Chart API"
+ :> QueryParam "from" UTCTime
+ :> QueryParam "to" UTCTime
+ :> QueryParamR "ngramsType" TabType
+ :> Get '[JSON] (ChartMetrics Histo)
+
+type TreeApi = Summary " Tree API"
+ :> QueryParam "from" UTCTime
+ :> QueryParam "to" UTCTime
+ :> QueryParamR "ngramsType" TabType
+ :> QueryParamR "listType" ListType
+ :> Get '[JSON] (ChartMetrics [MyTree])
-- Depending on the Type of the Node, we could post
-- New documents for a corpus
-- New map list terms
-- :<|> "process" :> MultipartForm MultipartData :> Post '[JSON] Text
-
- -- To launch a query and update the corpus
- -- :<|> "query" :> Capture "string" Text :> Get '[JSON] Text
+------------------------------------------------------------------------
--- | Node API functions
-roots :: Connection -> Server Roots
-roots conn = liftIO (putStrLn ( "/user" :: Text) >> getNodesWithParentId 0 Nothing conn)
- :<|> pure (panic "not implemented yet") -- TODO
- :<|> pure (panic "not implemented yet") -- TODO
- :<|> pure (panic "not implemented yet") -- TODO
-
-
-type GraphAPI = Get '[JSON] Graph
-graphAPI :: Connection -> NodeId -> Server GraphAPI
-graphAPI _ _ = liftIO $ textFlow (Mono EN) (Contexts contextText)
- -- TODO what do we get about the node? to replace contextText
+{-
+NOTE: These instances are not necessary. However, these messages could be part
+ of a display function for NodeError/TreeError.
+instance HasNodeError ServantErr where
+ _NodeError = prism' mk (const Nothing) -- panic "HasNodeError ServantErr: not a prism")
+ where
+ e = "Gargantext NodeError: "
+ mk NoListFound = err404 { errBody = e <> "No list found" }
+ mk NoRootFound = err404 { errBody = e <> "No Root found" }
+ mk NoCorpusFound = err404 { errBody = e <> "No Corpus found" }
+ mk NoUserFound = err404 { errBody = e <> "No User found" }
+
+ mk MkNode = err500 { errBody = e <> "Cannot mk node" }
+ mk NegativeId = err500 { errBody = e <> "Node with negative Id" }
+ mk UserNoParent = err500 { errBody = e <> "Should not have parent"}
+ mk HasParent = err500 { errBody = e <> "NodeType has parent" }
+ mk NotImplYet = err500 { errBody = e <> "Not implemented yet" }
+ mk ManyParents = err500 { errBody = e <> "Too many parents" }
+ mk ManyNodeUsers = err500 { errBody = e <> "Many userNode/user" }
--- TODO(orphan): There should be a proper APIError data type with a case TreeError.
instance HasTreeError ServantErr where
- _TreeError = prism' mk (const Nothing) -- Note a prism
+ _TreeError = prism' mk (const Nothing) -- panic "HasTreeError ServantErr: not a prism")
where
- mk NoRoot = err404 { errBody = "Root node not found" }
- mk EmptyRoot = err500 { errBody = "Root node should not be empty" }
- mk TooManyRoots = err500 { errBody = "Too many root nodes" }
-
-type TreeAPI = Get '[JSON] (Tree NodeTree)
-treeAPI :: Connection -> NodeId -> Server TreeAPI
-treeAPI = treeDB
-
-nodeAPI :: Connection -> NodeId -> Server NodeAPI
-nodeAPI conn id = liftIO (putStrLn ("/node" :: Text) >> getNode conn id )
- :<|> postNode conn id
- :<|> putNode conn id
- :<|> deleteNode' conn id
- :<|> getNodesWith' conn id
- :<|> getFacet conn id
- :<|> getChart conn id
- -- :<|> upload
- -- :<|> query
-
-nodesAPI :: Connection -> [NodeId] -> Server NodesAPI
-nodesAPI conn ids = deleteNodes' conn ids
-
-postNode :: Connection -> NodeId -> Handler Int
-postNode = undefined -- TODO
-
-putNode :: Connection -> NodeId -> Handler Int
-putNode = undefined -- TODO
-
-deleteNodes' :: Connection -> [NodeId] -> Handler Int
-deleteNodes' conn ids = liftIO (deleteNodes conn ids)
-
-deleteNode' :: Connection -> NodeId -> Handler Int
-deleteNode' conn id = liftIO (deleteNode conn id)
-
-getNodesWith' :: Connection -> NodeId -> Maybe NodeType -> Maybe Int -> Maybe Int
- -> Handler [Node Value]
-getNodesWith' conn id nodeType offset limit = liftIO (getNodesWith conn id nodeType offset limit)
-
-
-getFacet :: Connection -> NodeId -> Maybe Int -> Maybe Int
- -> Handler [FacetDoc]
-getFacet conn id offset limit = liftIO (putStrLn ( "/facet" :: Text)) >> liftIO (getDocFacet conn NodeCorpus id (Just Document) offset limit)
-
-getChart :: Connection -> NodeId -> Maybe UTCTime -> Maybe UTCTime
- -> Handler [FacetChart]
-getChart _ _ _ _ = undefined -- TODO
-
+ e = "TreeError: "
+ mk NoRoot = err404 { errBody = e <> "Root node not found" }
+ mk EmptyRoot = err500 { errBody = e <> "Root node should not be empty" }
+ mk TooManyRoots = err500 { errBody = e <> "Too many root nodes" }
+-}
-query :: Text -> Handler Text
-query s = pure s
+type TreeAPI = QueryParams "type" NodeType :> Get '[JSON] (Tree NodeTree)
+treeAPI :: NodeId -> GargServer TreeAPI
+treeAPI = treeDB
--- | Upload files
--- TODO Is it possible to adapt the function according to iValue input ?
---upload :: MultipartData -> Handler Text
---upload multipartData = do
--- liftIO $ do
--- putStrLn "Inputs:"
--- forM_ (inputs multipartData) $ \input ->
--- putStrLn $ " " <> show (iName input)
--- <> " -> " <> show (iValue input)
---
--- forM_ (files multipartData) $ \file -> do
--- content <- readFile (fdFilePath file)
--- putStrLn $ "Content of " <> show (fdFileName file)
--- <> " at " <> fdFilePath file
--- putStrLn content
--- pure (pack "Data loaded")
+------------------------------------------------------------------------
+-- | Check if the name is less than 255 char
+rename :: NodeId -> RenameNode -> Cmd err [Int]
+rename nId (RenameNode name') = U.update (U.Rename nId name')
+
+postNode :: HasNodeError err
+ => UserId
+ -> NodeId
+ -> PostNode
+ -> Cmd err [NodeId]
+postNode uId pId (PostNode nodeName nt) = do
+ nodeUser <- getNodeUser (NodeId uId)
+ let uId' = nodeUser ^. node_userId
+ mkNodeWithParent nt (Just pId) uId' nodeName
+
+putNode :: forall err a. (HasNodeError err, JSONB a, ToJSON a)
+ => NodeId
+ -> a
+ -> Cmd err Int
+putNode n h = fromIntegral <$> updateHyperdata n h
+-------------------------------------------------------------