src/Gargantext/Database/Bashql.hs

   1 {-|
   2 Module      : Gargantext.Database.Bashql
   3 Description : BASHQL to deal with Gargantext Database.
   4 Copyright   : (c) CNRS, 2017-Present
   5 License     : AGPL + CECILL v3
   6 Maintainer  : team@gargantext.org
   7 Stability   : experimental
   8 Portability : POSIX
   9
  10 * BASHQL is a Domain Specific Language to deal with the Database
  11
  12 * BASHQL = functional (Bash * SQL)
  13
  14 * Which language to chose when working with a database ? To make it
  15 simple, instead of all common Object Relational Mapping (ORM) [1]
  16 strategy used nowadays inspired more by object logic than functional
  17 logic, the semantics of BASHQL with focus on the function first.
  18
  19 * BASHQL focus on the function, i.e. use bash language function name,
  20 and make it with SQL behind the scene. Then BASHQL is inspired more
  21 by Bash language [2] than SQL and then follows its main commands as
  22 specification and documentation.
  23
  24 * Main arguments:
  25   1. Theoritical: database and FileSystems are each thought as a single
  26   category, assumption based on theoretical work on databases by David Spivak [0].
  27   2. Practical argument: basic bash commands are a daily practice among
  28   developper community.
  29
  30 * How to help ?
  31   1. Choose a command you like in Bash
  32   2. Implement it in Haskell-SQL according to Gargantext Shema (Tree like
  33   filesystem)
  34   3. Translate it in BASHQL (follow previous implementations)
  35   4. Make a pull request    (enjoy the community)
  36
  37 * Implementation strategy: Functional adapations are made to the
  38 gargantext languages options and SQL optimization are done continuously
  39 during the project. For the Haskellish part, you may be inspired by
  40 Turtle implementation written by Gabriel Gonzales [3] which shows how to
  41 write Haskell bash translations.
  42
  43 * Semantics
  44 - FileSystem is now a NodeSystem where each File is a Node in a Directed Graph (DG).
  45
  46 * References
  47
  48 [0] MIT Press has published "Category theory for the sciences". The book
  49 can also be purchased on Amazon. Here are reviews by the MAA, by the
  50 AMS, and by SIAM.
  51
  52 [1] https://en.wikipedia.org/wiki/Object-relational_mapping
  53
  54 [2] https://en.wikipedia.org/wiki/Bash_(Unix_shell)
  55
  56 [3] https://github.com/Gabriel439/Haskell-Turtle-Library
  57
  58 -}
  59
  60 {-# LANGUAGE NoImplicitPrelude #-}
  61 {-# LANGUAGE FlexibleContexts  #-}
  62
  63 module Gargantext.Database.Bashql ( get
  64                                   , ls
  65                                   , home
  66                                   , post
  67                                   , del
  68                                   , mv
  69                                   , put
  70                                   , rename
  71                                   , tree
  72                                   -- , mkCorpus, mkAnnuaire
  73                                   , runCmd'
  74                                  )
  75     where
  76
  77 import Control.Monad.Reader -- (Reader, ask)
  78
  79 import Data.Text (Text)
  80 import Data.Aeson
  81 import Data.List (concat, last)
  82
  83 import Gargantext.Core.Types
  84 import Gargantext.Database.Utils (connectGargandb)
  85 import Gargantext.Database.Node
  86 import qualified Gargantext.Database.Node.Update as U (Update(..), update)
  87 import Gargantext.Prelude
  88
  89 import Opaleye hiding (FromField)
  90
  91
  92 -- List of NodeId
  93 -- type PWD a = PWD UserId [a]
  94 type PWD = [NodeId]
  95 --data PWD' a = a | PWD' [a]
  96
  97 rename :: NodeId -> Text -> Cmd [Int]
  98 rename n t = mkCmd $ \conn -> U.update (U.Rename n t) conn
  99
 100 mv :: NodeId -> ParentId -> Cmd [Int]
 101 mv n p = mkCmd $ \conn -> U.update (U.Move n p) conn
 102
 103 -- | TODO get Children or Node
 104 get :: PWD -> Cmd [Node Value]
 105 get []  = pure []
 106 get pwd = Cmd . ReaderT $ \conn -> runQuery conn $ selectNodesWithParentID (last pwd)
 107
 108 -- | Home, need to filter with UserId
 109 home :: Cmd PWD
 110 home = map _node_id <$> Cmd (ReaderT (getNodesWithParentId 0 Nothing))
 111
 112 -- | ls == get Children
 113 ls :: PWD -> Cmd [Node Value]
 114 ls = get
 115
 116 tree :: PWD -> Cmd [Node Value]
 117 tree p = do
 118   ns       <- get p
 119   children <- mapM (\n -> get [_node_id n]) ns
 120   pure $ ns <> concat children
 121
 122 -- | TODO
 123 post :: PWD -> [NodeWrite'] -> Cmd Int64
 124 post [] _   = pure 0
 125 post _ []   = pure 0
 126 post pth ns = Cmd . ReaderT $ insertNodesWithParent (Just $ last pth) ns
 127
 128 --postR :: PWD -> [NodeWrite'] -> Cmd [Int]
 129 --postR [] _ _ = pure [0]
 130 --postR _ [] _ = pure [0]
 131 --postR pth ns c = mkNodeR (last pth) ns c
 132
 133 -- | WIP
 134 -- rm : mv to trash
 135 -- del : empty trash
 136 --rm :: Connection -> PWD -> [NodeId] -> IO Int
 137 --rm = del
 138 del :: [NodeId] -> Cmd Int
 139 del [] = pure 0
 140 del ns = deleteNodes ns
 141
 142 -- | TODO
 143 put :: U.Update -> Cmd [Int]
 144 put u = mkCmd $ U.update u
 145
 146 -- | TODO
 147 -- cd (Home UserId) | (Node NodeId)
 148 -- cd Path
 149 -- jump NodeId
 150 -- touch Dir
 151
 152 -- type Name = Text
 153
 154
 155 --mkCorpus :: ToJSON a => Name -> (a -> Text) -> [a] -> Cmd NewNode
 156 --mkCorpus name title ns = do
 157 --  pid <- home
 158 --
 159 --  let pid' = case lastMay pid of
 160 --        Nothing -> printDebug "No home for" name
 161 --        Just p  -> p
 162 --
 163 --  let uid = 1
 164 --  postNode uid (Just pid') ( Node' NodeCorpus  name emptyObject
 165 --                       (map (\n -> Node' Document (title n) (toJSON n) []) ns)
 166 --                   )
 167 --
 168 ---- |
 169 ---- import IMTClient as C
 170 ---- postAnnuaire "Annuaire IMT" (\n -> (maybe "" identity (C.prenom n)) <> " " <> (maybe "" identity (C.nom n))) (take 30 annuaire)
 171 --mkAnnuaire :: ToJSON a => Name -> (a -> Text) -> [a] -> Cmd NewNode
 172 --mkAnnuaire name title ns = do
 173 --  pid <- lastMay <$> home
 174 --  let pid' = case lastMay pid of
 175 --        Nothing -> printDebug "No home for" name
 176 --        Just p  -> p
 177 --  let uid = 1
 178 --  postNode uid (Just pid') ( Node' Annuaire  name emptyObject
 179 --                       (map (\n -> Node' UserPage (title n) (toJSON n) []) ns)
 180 --                   )
 181
 182 --------------------------------------------------------------
 183 -- |
 184 -- myCorpus <- Prelude.map doc2hyperdataDocument <$> toDocs <$> snd <$> readCsv "doc/corpus_imt/Gargantext_Corpus_small.csv"
 185 -- There is an error in the CSV parsing...
 186 -- let myCorpus' = Prelude.filter (\n -> T.length (maybe "" identity (hyperdataDocument_title n)) > 30) myCorpus
 187
 188 -- corporaOf :: Username -> IO [Corpus]
 189
 190 runCmd' :: Cmd a -> IO a
 191 runCmd' f = connectGargandb "gargantext.ini" >>= \c -> runCmd c f