src/Gargantext/API/Node.hs

   1 {-|
   2 Module      : Gargantext.API.Node
   3 Description : Server API
   4 Copyright   : (c) CNRS, 2017-Present
   5 License     : AGPL + CECILL v3
   6 Maintainer  : team@gargantext.org
   7 Stability   : experimental
   8 Portability : POSIX
   9
  10 -- TODO-SECURITY: Critical
  11
  12 -- TODO-ACCESS: CanGetNode
  13 -- TODO-EVENTS: No events as this is a read only query.
  14 Node API
  15 -------------------------------------------------------------------
  16 -- TODO-ACCESS: access by admin only.
  17 --              At first let's just have an isAdmin check.
  18 --              Later: check userId CanDeleteNodes Nothing
  19 -- TODO-EVENTS: DeletedNodes [NodeId]
  20 --              {"tag": "DeletedNodes", "nodes": [Int*]}
  21
  22 -}
  23
  24 {-# OPTIONS_GHC -fno-warn-orphans #-}
  25
  26 {-# LANGUAGE ScopedTypeVariables  #-}
  27 {-# LANGUAGE TemplateHaskell      #-}
  28 {-# LANGUAGE TypeOperators        #-}
  29
  30 module Gargantext.API.Node
  31   where
  32
  33 import Data.Aeson (FromJSON, ToJSON)
  34 import Data.Aeson.TH (deriveJSON)
  35 import Data.Maybe
  36 import Data.Swagger
  37 import Data.Text (Text())
  38 import GHC.Generics (Generic)
  39 import Servant
  40 import Test.QuickCheck (elements)
  41 import Test.QuickCheck.Arbitrary (Arbitrary, arbitrary)
  42
  43 import Gargantext.API.Admin.Auth (withAccess, PathId(..))
  44 import Gargantext.API.Metrics
  45 import Gargantext.API.Ngrams (TabType(..), TableNgramsApi, apiNgramsTableCorpus)
  46 import Gargantext.API.Node.File
  47 import Gargantext.API.Node.New
  48 import Gargantext.API.Prelude
  49 import Gargantext.API.Table
  50 import Gargantext.Core.Types (NodeTableResult)
  51 import Gargantext.Core.Types.Individu (User(..))
  52 import Gargantext.Core.Types.Main (Tree, NodeTree)
  53 import Gargantext.Core.Utils.Prefix (unPrefix)
  54 import Gargantext.Database.Action.Flow.Pairing (pairing)
  55 import Gargantext.Database.Admin.Types.Hyperdata
  56 import Gargantext.Database.Admin.Types.Node
  57 import Gargantext.Database.Prelude -- (Cmd, CmdM)
  58 import Gargantext.Database.Query.Facet (FacetDoc, OrderBy(..))
  59 import Gargantext.Database.Query.Table.Node
  60 import Gargantext.Database.Query.Table.Node.Children (getChildren)
  61 import Gargantext.Database.Query.Table.Node.Error (HasNodeError(..))
  62 import Gargantext.Database.Query.Table.Node.Update (Update(..), update)
  63 import Gargantext.Database.Query.Table.Node.UpdateOpaleye (updateHyperdata)
  64 import Gargantext.Database.Query.Table.NodeNode
  65 import Gargantext.Database.Query.Tree (tree, TreeMode(..))
  66 import Gargantext.Prelude
  67 import Gargantext.Viz.Phylo.API (PhyloAPI, phyloAPI)
  68 import qualified Gargantext.API.Node.Share  as Share
  69 import qualified Gargantext.API.Node.Update as Update
  70 import qualified Gargantext.API.Search as Search
  71 import qualified Gargantext.Database.Action.Delete as Action (deleteNode)
  72 import qualified Gargantext.Database.Query.Table.Node.Update as U (update, Update(..))
  73
  74 {-
  75 import qualified Gargantext.Text.List.Learn as Learn
  76 import qualified Data.Vector as Vec
  77 --}
  78
  79 -- | Admin NodesAPI
  80 -- TODO
  81 type NodesAPI  = Delete '[JSON] Int
  82
  83 -- | Delete Nodes
  84 -- Be careful: really delete nodes
  85 -- Access by admin only
  86 nodesAPI :: [NodeId] -> GargServer NodesAPI
  87 nodesAPI = deleteNodes
  88
  89 ------------------------------------------------------------------------
  90 -- | TODO-ACCESS: access by admin only.
  91 -- At first let's just have an isAdmin check.
  92 -- Later: CanAccessAnyNode or (CanGetAnyNode, CanPutAnyNode)
  93 -- To manage the Users roots
  94 -- TODO-EVENTS:
  95 --   PutNode ?
  96 -- TODO needs design discussion.
  97 type Roots =  Get    '[JSON] [Node HyperdataUser]
  98          :<|> Put    '[JSON] Int -- TODO
  99
 100 -- | TODO: access by admin only
 101 roots :: GargServer Roots
 102 roots = getNodesWithParentId Nothing
 103     :<|> pure (panic "not implemented yet") -- TODO use patch map to update what we need
 104
 105 -------------------------------------------------------------------
 106 -- | Node API Types management
 107 -- TODO-ACCESS : access by users
 108 -- No ownership check is needed if we strictly follow the capability model.
 109 --
 110 -- CanGetNode (Node, Children, TableApi, TableNgramsApiGet, PairingApi, ChartApi,
 111 --             SearchAPI)
 112 -- CanRenameNode (or part of CanEditNode?)
 113 -- CanCreateChildren (PostNodeApi)
 114 -- CanEditNode / CanPutNode TODO not implemented yet
 115 -- CanDeleteNode
 116 -- CanPatch (TableNgramsApi)
 117 -- CanFavorite
 118 -- CanMoveToTrash
 119
 120 type NodeAPI a = Get '[JSON] (Node a)
 121              :<|> "rename" :> RenameApi
 122              :<|> PostNodeApi -- TODO move to children POST
 123              :<|> PostNodeAsync
 124              :<|> ReqBody '[JSON] a :> Put    '[JSON] Int
 125              :<|> "update"     :> Update.API
 126              :<|> Delete '[JSON] Int
 127              :<|> "children"  :> ChildrenApi a
 128
 129              -- TODO gather it
 130              :<|> "table"      :> TableApi
 131              :<|> "ngrams"     :> TableNgramsApi
 132
 133              :<|> "category"   :> CatApi
 134              :<|> "search"     :> (Search.API Search.SearchResult)
 135              :<|> "share"      :> Share.API
 136
 137              -- Pairing utilities
 138              :<|> "pairwith"   :> PairWith
 139              :<|> "pairs"      :> Pairs
 140              :<|> "pairing"    :> PairingApi
 141
 142              -- VIZ
 143              :<|> "metrics"   :> ScatterAPI
 144              :<|> "chart"     :> ChartApi
 145              :<|> "pie"       :> PieApi
 146              :<|> "tree"      :> TreeApi
 147              :<|> "phylo"     :> PhyloAPI
 148              -- :<|> "add"       :> NodeAddAPI
 149              :<|> "move"      :> MoveAPI
 150              :<|> "unpublish" :> Share.Unpublish
 151
 152              :<|> "file"      :> FileApi
 153              :<|> "async"     :> FileAsyncApi
 154
 155 -- TODO-ACCESS: check userId CanRenameNode nodeId
 156 -- TODO-EVENTS: NodeRenamed RenameNode or re-use some more general NodeEdited...
 157 type RenameApi = Summary " Rename Node"
 158                :> ReqBody '[JSON] RenameNode
 159                :> Put     '[JSON] [Int]
 160
 161 type PostNodeApi = Summary " PostNode Node with ParentId as {id}"
 162                  :> ReqBody '[JSON] PostNode
 163                  :> Post    '[JSON] [NodeId]
 164
 165 type ChildrenApi a = Summary " Summary children"
 166                  :> QueryParam "type"   NodeType
 167                  :> QueryParam "offset" Int
 168                  :> QueryParam "limit"  Int
 169                  -- :> Get '[JSON] [Node a]
 170                  :> Get '[JSON] (NodeTableResult a)
 171
 172 ------------------------------------------------------------------------
 173 type NodeNodeAPI a = Get '[JSON] (Node a)
 174
 175 nodeNodeAPI :: forall proxy a. (JSONB a, ToJSON a)
 176             => proxy a
 177             -> UserId
 178             -> CorpusId
 179             -> NodeId
 180             -> GargServer (NodeNodeAPI a)
 181 nodeNodeAPI p uId cId nId = withAccess (Proxy :: Proxy (NodeNodeAPI a)) Proxy uId (PathNodeNode cId nId) nodeNodeAPI'
 182   where
 183     nodeNodeAPI' :: GargServer (NodeNodeAPI a)
 184     nodeNodeAPI' = getNodeWith nId p
 185
 186 ------------------------------------------------------------------------
 187 -- TODO: make the NodeId type indexed by `a`, then we no longer need the proxy.
 188 nodeAPI :: forall proxy a.
 189        ( JSONB a
 190        , FromJSON a
 191        , ToJSON a
 192        ) => proxy a
 193          -> UserId
 194          -> NodeId
 195          -> GargServer (NodeAPI a)
 196 nodeAPI p uId id' = withAccess (Proxy :: Proxy (NodeAPI a)) Proxy uId (PathNode id') nodeAPI'
 197   where
 198     nodeAPI' :: GargServer (NodeAPI a)
 199     nodeAPI' =  getNodeWith   id' p
 200            :<|> rename        id'
 201            :<|> postNode  uId id'
 202            :<|> postNodeAsyncAPI  uId id'
 203            :<|> putNode       id'
 204            :<|> Update.api  uId id'
 205            :<|> Action.deleteNode (RootId $ NodeId uId) id'
 206            :<|> getChildren   id' p
 207
 208            -- TODO gather it
 209            :<|> tableApi             id'
 210            :<|> apiNgramsTableCorpus id'
 211
 212            :<|> catApi      id'
 213            :<|> Search.api  id'
 214            :<|> Share.api   id'
 215            -- Pairing Tools
 216            :<|> pairWith    id'
 217            :<|> pairs       id'
 218            :<|> getPair     id'
 219
 220            :<|> scatterApi id'
 221            :<|> chartApi   id'
 222            :<|> pieApi     id'
 223            :<|> treeApi    id'
 224            :<|> phyloAPI   id' uId
 225            :<|> moveNode   (RootId $ NodeId uId) id'
 226            -- :<|> nodeAddAPI id'
 227            -- :<|> postUpload id'
 228            :<|> Share.unPublish id'
 229
 230            :<|> fileApi uId id'
 231            :<|> fileAsyncApi uId id'
 232
 233
 234 ------------------------------------------------------------------------
 235 data RenameNode = RenameNode { r_name :: Text }
 236   deriving (Generic)
 237
 238 ------------------------------------------------------------------------
 239 ------------------------------------------------------------------------
 240 type CatApi =  Summary " To Categorize NodeNodes: 0 for delete, 1/null neutral, 2 favorite"
 241             :> ReqBody '[JSON] NodesToCategory
 242             :> Put     '[JSON] [Int]
 243
 244 data NodesToCategory = NodesToCategory { ntc_nodesId :: [NodeId]
 245                                        , ntc_category :: Int
 246                                        }
 247   deriving (Generic)
 248
 249 -- TODO unPrefix "ntc_" FromJSON, ToJSON, ToSchema, adapt frontend.
 250 instance FromJSON  NodesToCategory
 251 instance ToJSON    NodesToCategory
 252 instance ToSchema  NodesToCategory
 253
 254 catApi :: CorpusId -> GargServer CatApi
 255 catApi = putCat
 256   where
 257     putCat :: CorpusId -> NodesToCategory -> Cmd err [Int]
 258     putCat cId cs' = nodeNodesCategory $ map (\n -> (cId, n, ntc_category cs')) (ntc_nodesId cs')
 259
 260 ------------------------------------------------------------------------
 261 -- TODO adapt FacetDoc -> ListDoc (and add type of document as column)
 262 -- Pairing utilities to move elsewhere
 263 type PairingApi = Summary " Pairing API"
 264                 :> QueryParam "view"   TabType
 265                 -- TODO change TabType -> DocType (CorpusId for pairing)
 266                 :> QueryParam "offset" Int
 267                 :> QueryParam "limit"  Int
 268                 :> QueryParam "order"  OrderBy
 269                 :> Get '[JSON] [FacetDoc]
 270
 271 ----------
 272 type Pairs    = Summary "List of Pairs"
 273               :> Get '[JSON] [AnnuaireId]
 274 pairs :: CorpusId -> GargServer Pairs
 275 pairs cId = do
 276   ns <- getNodeNode cId
 277   pure $ map _nn_node2_id ns
 278
 279 type PairWith = Summary "Pair a Corpus with an Annuaire"
 280               :> "annuaire" :> Capture "annuaire_id" AnnuaireId
 281               :> QueryParam "list_id"     ListId
 282               :> Post '[JSON] Int
 283
 284 pairWith :: CorpusId -> GargServer PairWith
 285 pairWith cId aId lId = do
 286   r <- pairing cId aId lId
 287   _ <- insertNodeNode [ NodeNode cId aId Nothing Nothing]
 288   pure r
 289
 290
 291 ------------------------------------------------------------------------
 292 type TreeAPI   = QueryParams "type" NodeType :> Get '[JSON] (Tree NodeTree)
 293
 294 treeAPI :: NodeId -> GargServer TreeAPI
 295 treeAPI = tree Advanced
 296
 297 ------------------------------------------------------------------------
 298 -- | TODO Check if the name is less than 255 char
 299 rename :: NodeId -> RenameNode -> Cmd err [Int]
 300 rename nId (RenameNode name') = U.update (U.Rename nId name')
 301
 302 putNode :: forall err a. (HasNodeError err, JSONB a, ToJSON a)
 303         => NodeId
 304         -> a
 305         -> Cmd err Int
 306 putNode n h = fromIntegral <$> updateHyperdata n h
 307
 308 -------------------------------------------------------------
 309 type MoveAPI  = Summary "Move Node endpoint"
 310               :> Capture "parent_id" ParentId
 311               :> Put '[JSON] [Int]
 312
 313 moveNode :: User
 314          -> NodeId
 315          -> ParentId
 316          -> Cmd err [Int]
 317 moveNode _u n p = update (Move n p)
 318 -------------------------------------------------------------
 319
 320
 321 $(deriveJSON (unPrefix "r_"       ) ''RenameNode )
 322 instance ToSchema  RenameNode
 323 instance Arbitrary RenameNode where
 324   arbitrary = elements [RenameNode "test"]
 325
 326
 327 -------------------------------------------------------------