Update README.md
[gargantext.git] / src / Gargantext / API / Ngrams / List.hs
index b2eab30924d8e3d62611512d396fc238822764b9..2c3a6345c19666b2c72b1e7c2e62ac20cd306fff 100644 (file)
@@ -16,63 +16,95 @@ module Gargantext.API.Ngrams.List
   where
 
 import Control.Lens hiding (elements, Indexed)
-import Data.Aeson
+import Data.Either (Either(..))
 import Data.HashMap.Strict (HashMap)
-import Data.Map (toList, fromList)
-import Data.Maybe (catMaybes)
+import Data.Map.Strict (Map, toList)
+import Data.Maybe (catMaybes, fromMaybe)
 import Data.Set (Set)
-import Data.Swagger (ToSchema, declareNamedSchema, genericDeclareNamedSchema)
-import Data.Text (Text, concat, pack)
-import GHC.Generics (Generic)
+import Data.Text (Text, concat, pack, splitOn)
+import Data.Vector (Vector)
+import Gargantext.API.Admin.EnvTypes (Env, GargJob(..))
 import Gargantext.API.Admin.Orchestrator.Types
-import Gargantext.API.Ngrams (getNgramsTableMap, setListNgrams)
+import Gargantext.API.Ngrams (setListNgrams)
+import Gargantext.API.Ngrams.List.Types
+import Gargantext.API.Ngrams.Prelude (getNgramsList)
 import Gargantext.API.Ngrams.Tools (getTermsWith)
 import Gargantext.API.Ngrams.Types
-import Gargantext.API.Node.Corpus.New.File (FileType(..))
-import Gargantext.API.Prelude (GargServer)
+import Gargantext.API.Prelude (GargServer, GargM, GargError)
+import Gargantext.API.Types
+import Gargantext.Core.NodeStory
 import Gargantext.Core.Text.Terms (ExtractedNgrams(..))
 import Gargantext.Core.Text.Terms.WithList (buildPatterns, termsInText)
 import Gargantext.Core.Types.Main (ListType(..))
-import Gargantext.Core.Utils.Prefix (unPrefixSwagger)
 import Gargantext.Database.Action.Flow (saveDocNgramsWith)
 import Gargantext.Database.Action.Flow.Types (FlowCmdM)
-import Gargantext.Database.Action.Metrics.NgramsByNode (getOccByNgramsOnlyFast')
 import Gargantext.Database.Admin.Types.Hyperdata.Document
 import Gargantext.Database.Admin.Types.Node
-import Gargantext.Database.Query.Table.NodeNode (selectDocNodes)
+import Gargantext.Database.Query.Table.Node (getNode)
+import Gargantext.Database.Query.Table.NodeContext (selectDocNodes)
+import Gargantext.Database.Schema.Context
 import Gargantext.Database.Schema.Ngrams
-import Gargantext.Database.Schema.Node
+import Gargantext.Database.Schema.Node (_node_parent_id)
 import Gargantext.Database.Types (Indexed(..))
 import Gargantext.Prelude
-import Network.HTTP.Media ((//), (/:))
+import Gargantext.Utils.Jobs (serveJobsAPI)
 import Servant
-import Servant.Job.Async
-import Servant.Job.Utils (jsonOptions)
-import Web.FormUrlEncoded (FromForm)
+-- import Servant.Job.Async
+import qualified Data.ByteString.Lazy as BSL
+import qualified Data.Csv as Csv
 import qualified Data.HashMap.Strict as HashMap
 import qualified Data.List           as List
-import qualified Data.Map            as Map
+import qualified Data.Map.Strict     as Map
+import qualified Data.Set            as Set
 import qualified Data.Text           as Text
-
+import qualified Data.Vector         as Vec
+import qualified Gargantext.Database.Query.Table.Ngrams as TableNgrams
+import qualified Gargantext.Utils.Servant as GUS
+import qualified Prelude
+import qualified Protolude           as P
 ------------------------------------------------------------------------
-type API =  Get '[JSON, HTML] (Headers '[Header "Content-Disposition" Text] NgramsList)
-       -- :<|> ReqBody '[JSON] NgramsList :> Post '[JSON] Bool
-       :<|> PostAPI
+type GETAPI = Summary "Get List"
+            :> "lists"
+              :> Capture "listId" ListId
+              :> "json"
+              :> Get '[JSON, HTML] (Headers '[Header "Content-Disposition" Text] NgramsList)
+            :<|> "lists"
+              :> Capture "listId" ListId
+              :> "csv"
+              :> Get '[GUS.CSV] (Headers '[Header "Content-Disposition" Text] NgramsTableMap)
+getApi :: GargServer GETAPI
+getApi = getJson :<|> getCsv
+
+----------------------
+type JSONAPI = Summary "Update List"
+          :> "lists"
+            :> Capture "listId" ListId
+          :> "add"
+          :> "form"
+          :> "async"
+            :> AsyncJobs JobLog '[FormUrlEncoded] WithJsonFile JobLog
+
+jsonApi :: ServerT JSONAPI (GargM Env GargError)
+jsonApi = jsonPostAsync
 
-api :: ListId -> GargServer API
-api l = get l :<|> postAsync l
+----------------------
+type CSVAPI = Summary "Update List (legacy v3 CSV)"
+          :> "lists"
+            :> Capture "listId" ListId
+          :> "csv"
+          :> "add"
+          :> "form"
+          :> "async"
+            :> AsyncJobs JobLog '[FormUrlEncoded] WithTextFile JobLog
 
-data HTML
-instance Accept HTML where
-  contentType _ = "text" // "html" /: ("charset", "utf-8")
-instance ToJSON a => MimeRender HTML a where
-  mimeRender _ = encode
+csvApi :: ServerT CSVAPI (GargM Env GargError)
+csvApi = csvPostAsync
 
 ------------------------------------------------------------------------
-get :: RepoCmdM env err m =>
+getJson :: HasNodeStory env err m =>
        ListId -> m (Headers '[Header "Content-Disposition" Text] NgramsList)
-get lId = do
-  lst <- get' lId
+getJson lId = do
+  lst <- getNgramsList lId
   let (NodeId id') = lId
   return $ addHeader (concat [ "attachment; filename=GarganText_NgramsList-"
                              , pack $ show id'
@@ -80,30 +112,38 @@ get lId = do
                              ]
                      ) lst
 
-get' :: RepoCmdM env err m
-    => ListId -> m NgramsList
-get' lId = fromList
-       <$> zip ngramsTypes
-       <$> mapM (getNgramsTableMap lId) ngramsTypes
+getCsv :: HasNodeStory env err m =>
+       ListId -> m (Headers '[Header "Content-Disposition" Text] NgramsTableMap)
+getCsv lId = do
+  lst <- getNgramsList lId
+  let (NodeId id') = lId
+  return $ case Map.lookup TableNgrams.NgramsTerms lst of
+    Nothing -> noHeader Map.empty
+    Just (Versioned { _v_data }) ->
+      addHeader (concat [ "attachment; filename=GarganText_NgramsList-"
+                        , pack $ show id'
+                        , ".csv"
+                        ]
+                ) _v_data
 
 ------------------------------------------------------------------------
 -- TODO : purge list
 -- TODO talk
-post :: FlowCmdM env err m
+setList :: FlowCmdM env err m
     => ListId
     -> NgramsList
     -> m Bool
-post l m  = do
+setList l m  = do
   -- TODO check with Version for optim
+  printDebug "New list as file" l
   _ <- mapM (\(nt, Versioned _v ns) -> setListNgrams l nt ns) $ toList m
   -- TODO reindex
   pure True
 
-
------------------------------------------------------------------------------
+------------------------------------------------------------------------
 -- | Re-index documents of a corpus with new ngrams (called orphans here)
-reIndexWith :: ( HasRepo env
-               , FlowCmdM env err m
+reIndexWith :: ( HasNodeStory env err m
+               , FlowCmdM     env err m
                )
             => CorpusId
             -> ListId
@@ -111,48 +151,50 @@ reIndexWith :: ( HasRepo env
             -> Set ListType
             -> m ()
 reIndexWith cId lId nt lts = do
+  printDebug "(cId,lId,nt,lts)" (cId, lId, nt, lts)
+
   -- Getting [NgramsTerm]
   ts <- List.concat
      <$> map (\(k,vs) -> k:vs)
      <$> HashMap.toList
      <$> getTermsWith identity [lId] nt lts
-  
-  --printDebug "ts" ts
 
-  -- Taking the ngrams with 0 occurrences only (orphans)
-  occs <- getOccByNgramsOnlyFast' cId lId nt ts
 
-  let orphans = List.concat 
+  let orphans = ts {- List.concat
               $ map (\t -> case HashMap.lookup t occs of
                        Nothing -> [t]
-                       Just n  -> if n == 1 then [t] else [ ]
+                       Just n  -> if n <= 1 then [t] else [ ]
                        ) ts
+                   -}
+
+  printDebug "orphans" orphans
 
   -- Get all documents of the corpus
   docs <- selectDocNodes cId
+  -- printDebug "docs length" (List.length docs)
 
   -- Checking Text documents where orphans match
   -- TODO Tests here
   let
-    ngramsByDoc = HashMap.fromList
-                $ map (\(k,v) -> (SimpleNgrams (text2ngrams k), v))
-                $ List.concat
-                 map (\doc -> List.zip
-                                (termsInText (buildPatterns $ map (\k -> ([unNgramsTerm k], [])) orphans)
-                                             $ Text.unlines $ catMaybes
-                                               [ doc ^. node_hyperdata . hd_title
-                                               , doc ^. node_hyperdata . hd_abstract
-                                               ]
+    -- fromListWith (<>)
+    ngramsByDoc = map (HashMap.fromList)
+                  $ map (map (\((k, cnt), v) -> (SimpleNgrams (text2ngrams k), over (traverse . traverse) (\p -> (p, cnt)) v)))
+                  $ map (\doc -> List.zip
+                                 (termsInText (buildPatterns $ map (\k -> (Text.splitOn " " $ unNgramsTerm k, [])) orphans)
+                                  $ Text.unlines $ catMaybes
+                                  [ doc ^. context_hyperdata . hd_title
+                                  , doc ^. context_hyperdata . hd_abstract
+                                  ]
                                  )
-                                (List.cycle [Map.fromList $ [(nt, Map.singleton (doc ^. node_id) 1 )]])
+                                 (List.cycle [Map.fromList $ [(nt, Map.singleton (doc ^. context_id) 1 )]])
                         ) docs
 
-  printDebug "ngramsByDoc" ngramsByDoc
+  printDebug "ngramsByDoc" ngramsByDoc
 
   -- Saving the indexation in database
-  _ <- saveDocNgramsWith lId ngramsByDoc
+  _ <- mapM (saveDocNgramsWith lId) ngramsByDoc
 
-  pure () -- ngramsByDoc
+  pure ()
 
 toIndexedNgrams :: HashMap Text NgramsId -> Text -> Maybe (Indexed Int Ngrams)
 toIndexedNgrams m t = Indexed <$> i <*> n
@@ -161,49 +203,128 @@ toIndexedNgrams m t = Indexed <$> i <*> n
     n = Just (text2ngrams t)
 
 ------------------------------------------------------------------------
-------------------------------------------------------------------------
-type PostAPI = Summary "Update List"
-        :> "add"
-        :> "form"
-        :> "async"
-        :> AsyncJobs JobLog '[FormUrlEncoded] WithFile JobLog
-
-postAsync :: ListId -> GargServer PostAPI
-postAsync lId =
-  serveJobsAPI $
-    JobFunction (\f  log' -> postAsync' lId f (liftBase . log'))
+jsonPostAsync :: ServerT JSONAPI (GargM Env GargError)
+jsonPostAsync lId =
+  serveJobsAPI UpdateNgramsListJobJSON $ \f log' ->
+      let
+        log'' x = do
+          -- printDebug "postAsync ListId" x
+          liftBase $ log' x
+      in postAsync' lId f log''
 
 postAsync' :: FlowCmdM env err m
           => ListId
-          -> WithFile
+          -> WithJsonFile
           -> (JobLog -> m ())
           -> m JobLog
-postAsync' l (WithFile _ m _) logStatus = do
+postAsync' l (WithJsonFile m _) logStatus = do
 
   logStatus JobLog { _scst_succeeded = Just 0
+                   , _scst_failed    = Just 0
+                   , _scst_remaining = Just 2
+                   , _scst_events    = Just []
+                   }
+  printDebug "New list as file" l
+  _ <- setList l m
+  -- printDebug "Done" r
+
+  logStatus JobLog { _scst_succeeded = Just 1
                    , _scst_failed    = Just 0
                    , _scst_remaining = Just 1
                    , _scst_events    = Just []
                    }
-  _r <- post l m
 
-  pure JobLog { _scst_succeeded = Just 1
+
+  corpus_node <- getNode l -- (Proxy :: Proxy HyperdataList)
+  let corpus_id = fromMaybe (panic "") (_node_parent_id corpus_node)
+  _ <- reIndexWith corpus_id l NgramsTerms (Set.fromList [MapTerm, CandidateTerm])
+
+  pure JobLog { _scst_succeeded = Just 2
               , _scst_failed    = Just 0
               , _scst_remaining = Just 0
               , _scst_events    = Just []
               }
 
-data WithFile = WithFile
-  { _wf_filetype :: !FileType
-  , _wf_data     :: !NgramsList
-  , _wf_name     :: !Text
-  } deriving (Eq, Show, Generic)
-
-makeLenses ''WithFile
-instance FromForm WithFile
-instance FromJSON WithFile where
-  parseJSON = genericParseJSON $ jsonOptions "_wf_"
-instance ToJSON WithFile where
-  toJSON = genericToJSON $ jsonOptions "_wf_"
-instance ToSchema WithFile where
-  declareNamedSchema = genericDeclareNamedSchema (unPrefixSwagger "_wf_")
+
+------------------------------------------------------------------------
+
+readCsvText :: Text -> [(Text, Text, Text)]
+readCsvText t = case eDec of
+  Left _ -> []
+  Right dec -> Vec.toList dec
+  where
+    lt = BSL.fromStrict $ P.encodeUtf8 t
+    eDec = Csv.decodeWith
+             (Csv.defaultDecodeOptions { Csv.decDelimiter = fromIntegral (P.ord '\t') })
+             Csv.HasHeader lt :: Either Prelude.String (Vector (Text, Text, Text))
+
+parseCsvData :: [(Text, Text, Text)] -> Map NgramsTerm NgramsRepoElement
+parseCsvData lst = Map.fromList $ conv <$> lst
+  where
+    conv (status, label, forms) =
+        (NgramsTerm label, NgramsRepoElement { _nre_size = 1
+                                             , _nre_list = case status == "map" of
+                                                             True  -> MapTerm
+                                                             False -> case status == "main" of
+                                                                True  -> CandidateTerm
+                                                                False -> StopTerm
+                                             , _nre_root = Nothing
+                                             , _nre_parent = Nothing
+                                             , _nre_children = MSet
+                                                             $ Map.fromList
+                                                             $ map (\form -> (NgramsTerm form, ()))
+                                                             $ filter (\w -> w /= "" && w /= label)
+                                                             $ splitOn "|&|" forms
+                                             }
+         )
+
+csvPost :: FlowCmdM env err m
+        => ListId
+        -> Text
+        -> m Bool
+csvPost l m  = do
+  printDebug "[csvPost] l" l
+  -- printDebug "[csvPost] m" m
+  -- status label forms
+  let lst = readCsvText m
+  let p = parseCsvData lst
+  --printDebug "[csvPost] lst" lst
+  printDebug "[csvPost] p" p
+  _ <- setListNgrams l NgramsTerms p
+  printDebug "ReIndexing List" l
+  corpus_node <- getNode l -- (Proxy :: Proxy HyperdataList)
+  let corpus_id = fromMaybe (panic "") (_node_parent_id corpus_node)
+  _ <- reIndexWith corpus_id l NgramsTerms (Set.fromList [MapTerm, CandidateTerm])
+
+  pure True
+
+------------------------------------------------------------------------
+csvPostAsync :: ServerT CSVAPI (GargM Env GargError)
+csvPostAsync lId =
+  serveJobsAPI UpdateNgramsListJobCSV $ \f@(WithTextFile ft _ n) log' -> do
+      let log'' x = do
+            printDebug "[csvPostAsync] filetype" ft
+            printDebug "[csvPostAsync] name" n
+            liftBase $ log' x
+      csvPostAsync' lId f log''
+
+
+csvPostAsync' :: FlowCmdM env err m
+             => ListId
+             -> WithTextFile
+             -> (JobLog -> m ())
+             -> m JobLog
+csvPostAsync' l (WithTextFile _ m _) logStatus = do
+  logStatus JobLog { _scst_succeeded = Just 0
+                   , _scst_failed    = Just 0
+                   , _scst_remaining = Just 1
+                   , _scst_events    = Just []
+                   }
+  _r <- csvPost l m
+
+  pure JobLog { _scst_succeeded = Just 1
+              , _scst_failed    = Just 0
+              , _scst_remaining = Just 0
+              , _scst_events    = Just []
+              }
+------------------------------------------------------------------------