[SECURITY] newtype GargPassword with Show hidden.
[gargantext.git] / src / Gargantext / Viz / Graph / API.hs
index ddac374108cfcecbef9fa09f3d149f94cecb28fe..6261da30c2f162898cb76a6617085c7b271b4137 100644 (file)
@@ -25,35 +25,82 @@ Portability : POSIX
 module Gargantext.Viz.Graph.API
   where
 
-import Debug.Trace (trace)
-import Control.Concurrent -- (forkIO)
 import Control.Lens (set, (^.), _Just, (^?))
 import Data.Aeson
+import Debug.Trace (trace)
+import qualified Data.HashMap.Lazy as HashMap
+import qualified Data.Map as Map
 import Data.Maybe (Maybe(..))
 import Data.Swagger
+import Data.Text
 import GHC.Generics (Generic)
+import Servant
+import Servant.Job.Async
+import Servant.XML
+import qualified Xmlbf as Xmlbf
 
 import Gargantext.API.Ngrams (NgramsRepo, r_version)
 import Gargantext.API.Ngrams.Tools
-import Gargantext.API.Types
+import Gargantext.API.Admin.Orchestrator.Types
+import Gargantext.API.Prelude
 import Gargantext.Core.Types.Main
-import Gargantext.Database.Config
-import Gargantext.Database.Metrics.NgramsByNode (getNodesByNgramsOnlyUser)
+import Gargantext.Database.Admin.Config
+import Gargantext.Database.Action.Metrics.NgramsByNode (getNodesByNgramsOnlyUser)
+import Gargantext.Database.Schema.Node (node_userId, node_parentId, node_hyperdata)
 import Gargantext.Database.Schema.Ngrams
-import Gargantext.Database.Node.Select
-import Gargantext.Database.Schema.Node (getNodeWith, getNodeUser, defaultList, insertGraph, HasNodeError)
-import Gargantext.Database.Types.Node hiding (node_id) -- (GraphId, ListId, CorpusId, NodeId)
-import Gargantext.Database.Node.UpdateOpaleye (updateHyperdata)
-import Gargantext.Database.Utils (Cmd)
+import Gargantext.Database.Query.Table.Node.Select
+import Gargantext.Database.Query.Table.Node
+import Gargantext.Database.Query.Table.Node.User
+import Gargantext.Database.Query.Table.Node.Error (HasNodeError)
+import Gargantext.Database.Admin.Types.Node
+import Gargantext.Database.Query.Table.Node.UpdateOpaleye (updateHyperdata)
+import Gargantext.Database.Prelude (Cmd)
 import Gargantext.Prelude
+import qualified Gargantext.Prelude as P
 import Gargantext.Viz.Graph
+import qualified Gargantext.Viz.Graph as G
 import Gargantext.Viz.Graph.Tools -- (cooc2graph)
-import Servant
 
-import Gargantext.API.Orchestrator.Types
-import Servant.Job.Types
-import Servant.Job.Async
-import qualified Data.Map as Map
+-- Converts to GEXF format
+-- See https://gephi.org/gexf/format/
+instance Xmlbf.ToXml Graph where
+  toXml (Graph { _graph_nodes = graphNodes
+                , _graph_edges = graphEdges }) = root graphNodes graphEdges
+    where
+      root :: [G.Node] -> [G.Edge] -> [Xmlbf.Node]
+      root gn ge =
+        Xmlbf.element "gexf" params $ meta <> (graph gn ge)
+        where
+          params = HashMap.fromList [ ("xmlns", "http://www.gexf.net/1.2draft")
+                                    , ("version", "1.2") ]
+      meta = Xmlbf.element "meta" params $ creator <> desc
+        where
+          params = HashMap.fromList [ ("lastmodifieddate", "2020-03-13") ]
+      creator = Xmlbf.element "creator" HashMap.empty $ Xmlbf.text "Gargantext.org"
+      desc = Xmlbf.element "description" HashMap.empty $ Xmlbf.text "Gargantext gexf file"
+      graph :: [G.Node] -> [G.Edge] -> [Xmlbf.Node]
+      graph gn ge = Xmlbf.element "graph" params $ (nodes gn) <> (edges ge)
+        where
+          params = HashMap.fromList [ ("mode", "static")
+                                    , ("defaultedgetype", "directed") ]
+      nodes :: [G.Node] -> [Xmlbf.Node]
+      nodes gn = Xmlbf.element "nodes" HashMap.empty $ P.concatMap node' gn
+
+      node' :: G.Node -> [Xmlbf.Node]
+      node' (G.Node { node_id = nId, node_label = l }) =
+        Xmlbf.element "node" params []
+        where
+          params = HashMap.fromList [ ("id", nId)
+                                    , ("label", l) ]
+      edges :: [G.Edge] -> [Xmlbf.Node]
+      edges gn = Xmlbf.element "edges" HashMap.empty $ P.concatMap edge gn
+      edge :: G.Edge -> [Xmlbf.Node]
+      edge (G.Edge { edge_id = eId, edge_source = es, edge_target = et }) =
+        Xmlbf.element "edge" params []
+        where
+          params = HashMap.fromList [ ("id", eId)
+                                    , ("source", es)
+                                    , ("target", et) ]
 
 ------------------------------------------------------------------------
 
@@ -62,9 +109,10 @@ import qualified Data.Map as Map
 type GraphAPI   =  Get  '[JSON] Graph
               :<|> Post '[JSON] [GraphId]
               :<|> Put  '[JSON] Int
+              :<|> "gexf" :> Get '[XML] (Headers '[Servant.Header "Content-Disposition" Text] Graph)
               :<|> GraphAsyncAPI
               :<|> "versions" :> GraphVersionsAPI
-
+             
 
 data GraphVersions = GraphVersions { gv_graph :: Maybe Int
                                    , gv_repo :: Int } deriving (Show, Generic)
@@ -76,24 +124,12 @@ graphAPI :: UserId -> NodeId -> GargServer GraphAPI
 graphAPI u n =  getGraph  u n
          :<|> postGraph n
          :<|> putGraph  n
+         :<|> getGraphGexf u n
          :<|> graphAsync u n
          :<|> graphVersionsAPI u n
 
 ------------------------------------------------------------------------
 
-{- Model to fork Graph Computation
--- This is not really optimized since it increases the need RAM
--- and freezes the whole system
--- This is mainly for documentation (see a better solution in the function below)
--- Each process has to be tailored
-getGraph' :: UserId -> NodeId -> GargServer (Get '[JSON] Graph)
-getGraph' u n = do
-  newGraph  <- liftBase newEmptyMVar
-  g  <- getGraph u n
-  _  <- liftBase $ forkIO $ putMVar newGraph g
-  g' <- liftBase $ takeMVar newGraph
-  pure g'
--}
 getGraph :: UserId -> NodeId -> GargNoServer Graph
 getGraph uId nId = do
   nodeGraph <- getNodeWith nId HyperdataGraph
@@ -128,11 +164,8 @@ getGraph uId nId = do
     --                    graph'' <- computeGraph cId NgramsTerms repo
     --                    _ <- updateHyperdata nId (HyperdataGraph $ Just graph'')
     --                    pure graph''
-
-  newGraph  <- liftBase newEmptyMVar
-  _  <- liftBase $ forkIO $ putMVar newGraph g
-  g' <- liftBase $ takeMVar newGraph
-  pure {- $ trace (show g) $ -} g'
+  
+  pure g
 
 
 recomputeGraph :: UserId -> NodeId -> GargNoServer Graph
@@ -157,30 +190,18 @@ recomputeGraph uId nId = do
 
   g <- case graph of
     Nothing     -> do
-      graph' <- computeGraphAsync cId NgramsTerms repo
+      graph' <- computeGraph cId NgramsTerms repo
       _ <- insertGraph cId uId' (HyperdataGraph $ Just graph')
       pure $ trace "[recomputeGraph] Graph empty, computing" $ graph'
 
     Just graph' -> if listVersion == Just v
                      then pure graph'
                      else do
-                       graph'' <- computeGraphAsync cId NgramsTerms repo
+                       graph'' <- computeGraph cId NgramsTerms repo
                        _ <- updateHyperdata nId (HyperdataGraph $ Just graph'')
                        pure $ trace "[recomputeGraph] Graph exists, recomputing" $ graph''
-
   pure g
 
-computeGraphAsync :: HasNodeError err
-             => CorpusId
-             -> NgramsType
-             -> NgramsRepo
-             -> Cmd err Graph
-computeGraphAsync cId nt repo = do
-  g <- liftBase newEmptyMVar
-  _ <- forkIO <$> putMVar g <$> computeGraph cId nt repo
-  g' <- liftBase $ takeMVar g
-  pure g'
-
 
 -- TODO use Database Monad only here ?
 computeGraph :: HasNodeError err
@@ -202,11 +223,11 @@ computeGraph cId nt repo = do
   let ngs = filterListWithRoot GraphTerm $ mapTermListRoot [lId] nt repo
 
   myCooc <- Map.filter (>1)
-         <$> getCoocByNgrams (Diagonal False)
+         <$> getCoocByNgrams (Diagonal True)
          <$> groupNodesByNgrams ngs
          <$> getNodesByNgramsOnlyUser cId (lIds <> [lId]) nt (Map.keys ngs)
 
-  let graph  = cooc2graph 0 myCooc
+  graph <- liftBase $ cooc2graph 0 myCooc
   let graph' = set graph_metadata (Just metadata) graph
   pure graph'
 
@@ -218,6 +239,14 @@ postGraph = undefined
 putGraph :: NodeId -> GargServer (Put '[JSON] Int)
 putGraph = undefined
 
+
+------------------------------------------------------------
+
+getGraphGexf :: UserId -> NodeId -> GargNoServer (Headers '[Servant.Header "Content-Disposition" Text] Graph)
+getGraphGexf uId nId = do
+  graph <- getGraph uId nId
+  pure $ addHeader (concat [ "attachment; filename=graph.gexf" ]) graph
+
 ------------------------------------------------------------
 
 type GraphAsyncAPI = Summary "Update graph"