src/Gargantext/Database/Admin/Bashql.hs

   1 {-# OPTIONS_GHC -fno-warn-unused-top-binds #-}
   2 {-|
   3 Module      : Gargantext.Database.Bashql
   4 Description : BASHQL to deal with Gargantext Database.
   5 Copyright   : (c) CNRS, 2017-Present
   6 License     : AGPL + CECILL v3
   7 Maintainer  : team@gargantext.org
   8 Stability   : experimental
   9 Portability : POSIX
  10
  11 * BASHQL is a Domain Specific Language to deal with the Database
  12
  13 * BASHQL = functional (Bash * SQL)
  14
  15 * Which language to chose when working with a database ? To make it
  16 simple, instead of all common Object Relational Mapping (ORM) [1]
  17 strategy used nowadays inspired more by object logic than functional
  18 logic, the semantics of BASHQL with focus on the function first.
  19
  20 * BASHQL focus on the function, i.e. use bash language function name,
  21 and make it with SQL behind the scene. Then BASHQL is inspired more
  22 by Bash language [2] than SQL and then follows its main commands as
  23 specification and documentation.
  24
  25 * Main arguments:
  26   1. Theoritical: database and FileSystems are each thought as a single
  27   category, assumption based on theoretical work on databases by David Spivak [0].
  28   2. Practical argument: basic bash commands are a daily practice among
  29   developper community.
  30
  31 * How to help ?
  32   1. Choose a command you like in Bash
  33   2. Implement it in Haskell-SQL according to Gargantext Shema (Tree like
  34   filesystem)
  35   3. Translate it in BASHQL (follow previous implementations)
  36   4. Make a pull request    (enjoy the community)
  37
  38 * Implementation strategy: Functional adapations are made to the
  39 gargantext languages options and SQL optimization are done continuously
  40 during the project. For the Haskellish part, you may be inspired by
  41 Turtle implementation written by Gabriel Gonzales [3] which shows how to
  42 write Haskell bash translations.
  43
  44 * Semantics
  45 - FileSystem is now a NodeSystem where each File is a Node in a Directed Graph (DG).
  46
  47 * References
  48
  49 [0] MIT Press has published "Category theory for the sciences". The book
  50 can also be purchased on Amazon. Here are reviews by the MAA, by the
  51 AMS, and by SIAM.
  52
  53 [1] https://en.wikipedia.org/wiki/Object-relational_mapping
  54
  55 [2] https://en.wikipedia.org/wiki/Bash_(Unix_shell)
  56
  57 [3] https://github.com/Gabriel439/Haskell-Turtle-Library
  58
  59 TODO-ACCESS: should the checks be done here or before.
  60
  61 -}
  62
  63
  64 module Gargantext.Database.Admin.Bashql () {-( get
  65                                   , ls
  66                                   , home
  67                                   , post
  68                                   , del
  69                                   , mv
  70                                   , put
  71                                   , rename
  72                                   , tree
  73                                   -- , mkCorpus, mkAnnuaire
  74                                  )-}
  75     where
  76
  77 import Control.Monad.Reader -- (Reader, ask)
  78 import Data.Text (Text)
  79 import Data.List (concat, last)
  80 import Gargantext.Core.Types
  81 import Gargantext.Database.Prelude (runOpaQuery, Cmd)
  82 import Gargantext.Database.Schema.Node
  83 import Gargantext.Database.Query.Table.Node
  84 import qualified Gargantext.Database.Query.Table.Node.Update as U (Update(..), update)
  85 import Gargantext.Prelude
  86
  87
  88 -- List of NodeId
  89 -- type PWD a = PWD UserId [a]
  90 type PWD = [NodeId]
  91 --data PWD' a = a | PWD' [a]
  92
  93 rename :: NodeId -> Text -> Cmd err [Int]
  94 rename n t = U.update $ U.Rename n t
  95
  96 mv :: NodeId -> ParentId -> Cmd err [Int]
  97 mv n p = U.update $ U.Move n p
  98
  99 -- | TODO get Children or Node
 100 get :: PWD -> Cmd err [Node HyperdataAny]
 101 get []  = pure []
 102 get pwd = runOpaQuery $ selectNodesWithParentID (last pwd)
 103
 104 -- | Home, need to filter with UserId
 105 {-
 106 home :: Cmd err PWD
 107 home = map _node_id <$> getNodesWithParentId 0 Nothing
 108 -}
 109
 110 -- | ls == get Children
 111 ls :: PWD -> Cmd err [Node HyperdataAny]
 112 ls = get
 113
 114 tree :: PWD -> Cmd err [Node HyperdataAny]
 115 tree p = do
 116   ns       <- get p
 117   children <- mapM (\n -> get [_node_id n]) ns
 118   pure $ ns <> concat children
 119
 120 -- | TODO
 121 post :: PWD -> [NodeWrite] -> Cmd err Int64
 122 post [] _   = pure 0
 123 post _ []   = pure 0
 124 post pth ns = insertNodesWithParent (Just $ last pth) ns
 125
 126 --postR :: PWD -> [NodeWrite'] -> Cmd err [Int]
 127 --postR [] _ _ = pure [0]
 128 --postR _ [] _ = pure [0]
 129 --postR pth ns c = mkNodeR (last pth) ns c
 130
 131 -- | WIP
 132 -- rm : mv to trash
 133 -- del : empty trash
 134 --rm :: PWD -> [NodeId] -> IO Int
 135 --rm = del
 136 del :: [NodeId] -> Cmd err Int
 137 del [] = pure 0
 138 del ns = deleteNodes ns
 139
 140 -- | TODO
 141 put :: U.Update -> Cmd err [Int]
 142 put = U.update
 143
 144 -- | TODO
 145 -- cd (Home UserId) | (Node NodeId)
 146 -- cd Path
 147 -- jump NodeId
 148 -- touch Dir
 149
 150 -- type Name = Text
 151