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.Core.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.Core.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
 154 -- TODO-ACCESS: check userId CanRenameNode nodeId
 155 -- TODO-EVENTS: NodeRenamed RenameNode or re-use some more general NodeEdited...
 156 type RenameApi = Summary " Rename Node"
 157                :> ReqBody '[JSON] RenameNode
 158                :> Put     '[JSON] [Int]
 159
 160 type PostNodeApi = Summary " PostNode Node with ParentId as {id}"
 161                  :> ReqBody '[JSON] PostNode
 162                  :> Post    '[JSON] [NodeId]
 163
 164 type ChildrenApi a = Summary " Summary children"
 165                  :> QueryParam "type"   NodeType
 166                  :> QueryParam "offset" Int
 167                  :> QueryParam "limit"  Int
 168                  -- :> Get '[JSON] [Node a]
 169                  :> Get '[JSON] (NodeTableResult a)
 170
 171 ------------------------------------------------------------------------
 172 type NodeNodeAPI a = Get '[JSON] (Node a)
 173
 174 nodeNodeAPI :: forall proxy a. (JSONB a, ToJSON a)
 175             => proxy a
 176             -> UserId
 177             -> CorpusId
 178             -> NodeId
 179             -> GargServer (NodeNodeAPI a)
 180 nodeNodeAPI p uId cId nId = withAccess (Proxy :: Proxy (NodeNodeAPI a)) Proxy uId (PathNodeNode cId nId) nodeNodeAPI'
 181   where
 182     nodeNodeAPI' :: GargServer (NodeNodeAPI a)
 183     nodeNodeAPI' = getNodeWith nId p
 184
 185 ------------------------------------------------------------------------
 186 -- TODO: make the NodeId type indexed by `a`, then we no longer need the proxy.
 187 nodeAPI :: forall proxy a.
 188        ( JSONB a
 189        , FromJSON a
 190        , ToJSON a
 191        ) => proxy a
 192          -> UserId
 193          -> NodeId
 194          -> GargServer (NodeAPI a)
 195 nodeAPI p uId id' = withAccess (Proxy :: Proxy (NodeAPI a)) Proxy uId (PathNode id') nodeAPI'
 196   where
 197     nodeAPI' :: GargServer (NodeAPI a)
 198     nodeAPI' =  getNodeWith   id' p
 199            :<|> rename        id'
 200            :<|> postNode  uId id'
 201            :<|> postNodeAsyncAPI  uId id'
 202            :<|> putNode       id'
 203            :<|> Update.api  uId id'
 204            :<|> Action.deleteNode (RootId $ NodeId uId) id'
 205            :<|> getChildren   id' p
 206
 207            -- TODO gather it
 208            :<|> tableApi             id'
 209            :<|> apiNgramsTableCorpus id'
 210
 211            :<|> catApi      id'
 212            :<|> Search.api  id'
 213            :<|> Share.api   id'
 214            -- Pairing Tools
 215            :<|> pairWith    id'
 216            :<|> pairs       id'
 217            :<|> getPair     id'
 218
 219            -- VIZ
 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
 232
 233 ------------------------------------------------------------------------
 234 data RenameNode = RenameNode { r_name :: Text }
 235   deriving (Generic)
 236
 237 ------------------------------------------------------------------------
 238 ------------------------------------------------------------------------
 239 type CatApi =  Summary " To Categorize NodeNodes: 0 for delete, 1/null neutral, 2 favorite"
 240             :> ReqBody '[JSON] NodesToCategory
 241             :> Put     '[JSON] [Int]
 242
 243 data NodesToCategory = NodesToCategory { ntc_nodesId :: [NodeId]
 244                                        , ntc_category :: Int
 245                                        }
 246   deriving (Generic)
 247
 248 -- TODO unPrefix "ntc_" FromJSON, ToJSON, ToSchema, adapt frontend.
 249 instance FromJSON  NodesToCategory
 250 instance ToJSON    NodesToCategory
 251 instance ToSchema  NodesToCategory
 252
 253 catApi :: CorpusId -> GargServer CatApi
 254 catApi = putCat
 255   where
 256     putCat :: CorpusId -> NodesToCategory -> Cmd err [Int]
 257     putCat cId cs' = nodeNodesCategory $ map (\n -> (cId, n, ntc_category cs')) (ntc_nodesId cs')
 258
 259 ------------------------------------------------------------------------
 260 -- TODO adapt FacetDoc -> ListDoc (and add type of document as column)
 261 -- Pairing utilities to move elsewhere
 262 type PairingApi = Summary " Pairing API"
 263                 :> QueryParam "view"   TabType
 264                 -- TODO change TabType -> DocType (CorpusId for pairing)
 265                 :> QueryParam "offset" Int
 266                 :> QueryParam "limit"  Int
 267                 :> QueryParam "order"  OrderBy
 268                 :> Get '[JSON] [FacetDoc]
 269
 270 ----------
 271 type Pairs    = Summary "List of Pairs"
 272               :> Get '[JSON] [AnnuaireId]
 273 pairs :: CorpusId -> GargServer Pairs
 274 pairs cId = do
 275   ns <- getNodeNode cId
 276   pure $ map _nn_node2_id ns
 277
 278 type PairWith = Summary "Pair a Corpus with an Annuaire"
 279               :> "annuaire" :> Capture "annuaire_id" AnnuaireId
 280               :> QueryParam "list_id"     ListId
 281               :> Post '[JSON] Int
 282
 283 pairWith :: CorpusId -> GargServer PairWith
 284 pairWith cId aId lId = do
 285   r <- pairing cId aId lId
 286   _ <- insertNodeNode [ NodeNode cId aId Nothing Nothing]
 287   pure r
 288
 289
 290 ------------------------------------------------------------------------
 291 type TreeAPI   = QueryParams "type" NodeType :> Get '[JSON] (Tree NodeTree)
 292
 293 treeAPI :: NodeId -> GargServer TreeAPI
 294 treeAPI = tree Advanced
 295
 296 ------------------------------------------------------------------------
 297 -- | TODO Check if the name is less than 255 char
 298 rename :: NodeId -> RenameNode -> Cmd err [Int]
 299 rename nId (RenameNode name') = U.update (U.Rename nId name')
 300
 301 putNode :: forall err a. (HasNodeError err, JSONB a, ToJSON a)
 302         => NodeId
 303         -> a
 304         -> Cmd err Int
 305 putNode n h = fromIntegral <$> updateHyperdata n h
 306
 307 -------------------------------------------------------------
 308 type MoveAPI  = Summary "Move Node endpoint"
 309               :> Capture "parent_id" ParentId
 310               :> Put '[JSON] [Int]
 311
 312 moveNode :: User
 313          -> NodeId
 314          -> ParentId
 315          -> Cmd err [Int]
 316 moveNode _u n p = update (Move n p)
 317 -------------------------------------------------------------
 318
 319
 320 $(deriveJSON (unPrefix "r_"       ) ''RenameNode )
 321 instance ToSchema  RenameNode
 322 instance Arbitrary RenameNode where
 323   arbitrary = elements [RenameNode "test"]
 324
 325
 326 -------------------------------------------------------------