Ends.purs 9.59 KB
Newer Older
1 2 3 4 5
-- | Those things at the end of urls
module Gargantext.Ends
  -- ( )
  where

6
import Prelude (class Eq, class Show, show, ($), (/=), (<<<), (<>), (==))
7 8
import Data.Foldable (foldMap)
import Data.Generic.Rep (class Generic)
9
import Data.Eq.Generic (genericEq)
10
import Data.Maybe (Maybe(..), maybe, fromMaybe)
11 12 13
import Data.Newtype (class Newtype)
import Simple.JSON as JSON

14
import Gargantext.Routes as R
15
import Gargantext.Types (ApiVersion, ChartType(..), Limit, NodePath, NodeType(..), Offset, TabType(..), TermSize(..), nodePath, nodeTypePath, showTabType', TermList(MapTerm))
16 17 18 19 20 21 22 23

-- | A means of generating a url to visit, a destination
class ToUrl conf p where
  toUrl :: conf -> p -> String

url :: forall conf p. ToUrl conf p => conf -> p -> String
url = toUrl

24

25 26 27 28 29
-- | Encapsulates the data we need to talk to a backend server
newtype Backend = Backend
  { name    :: String
  , baseUrl :: String
  , prePath :: String
30
  , version :: ApiVersion
31
  , backendType :: String
32
  }
33 34 35 36
derive instance Generic Backend _
derive instance Newtype Backend _
derive newtype instance JSON.ReadForeign Backend
derive newtype instance JSON.WriteForeign Backend
37 38 39
instance Eq Backend where eq = genericEq
instance Show Backend where show (Backend {name}) = name
instance ToUrl Backend String where toUrl = backendUrl
40

41 42 43
type BaseUrl = String
type PrePath = String
type Name    = String
44 45 46 47
type BackendType = String

backend :: BackendType -> Name -> ApiVersion -> PrePath -> BaseUrl -> Backend
backend backendType name version prePath baseUrl = Backend { name, version, prePath, baseUrl, backendType}
48 49 50 51 52 53 54 55 56 57

-- | Creates a backend url from a backend and the path as a string
backendUrl :: Backend -> String -> String
backendUrl (Backend b) path = b.baseUrl <> b.prePath <> show b.version <> "/" <> path

-- | Encapsulates the data needed to construct a url to a frontend
-- | server (either for the app or static content)
newtype Frontend = Frontend
  { name    :: String
  , baseUrl :: String
58 59
  , prePath :: String
  }
60

61
derive instance Generic Frontend _
62 63 64 65 66
instance Eq Frontend where eq = genericEq
instance ToUrl Frontend NodePath where toUrl front np = frontendUrl front (nodePath np)
instance Show Frontend where show (Frontend {name}) = name
instance ToUrl Frontend String where toUrl = frontendUrl
instance ToUrl Frontend R.AppRoute where toUrl f r = frontendUrl f (R.appPath r)
67

68 69 70 71 72 73 74 75 76 77 78
-- | Creates a frontend
frontend :: String -> String -> String -> Frontend
frontend baseUrl prePath name = Frontend { name, baseUrl, prePath }

-- | Creates a url from a frontend and the path as a string
frontendUrl :: Frontend -> String -> String
frontendUrl (Frontend f) path = f.baseUrl <> f.prePath <> path

-- | The currently selected App and Static configurations
newtype Frontends = Frontends { app :: Frontend, static :: Frontend }

79
derive instance Eq Frontends
80 81
instance ToUrl Frontends R.AppRoute where toUrl f r = appUrl f (R.appPath r)
instance ToUrl Frontends NodePath where toUrl (Frontends {app}) np = frontendUrl app (nodePath np)
James Laver's avatar
James Laver committed
82

83 84 85 86 87 88 89 90 91
-- | Creates an app url from a Frontends and the path as a string
appUrl :: Frontends -> String -> String
appUrl (Frontends {app}) = frontendUrl app

-- | Creates a static url from a Frontends and the path as a string
staticUrl :: Frontends -> String -> String
staticUrl (Frontends {static}) = frontendUrl static

sessionPath :: R.SessionRoute -> String
92 93
sessionPath (R.Tab t i)             = sessionPath (R.NodeAPI Node i (showTabType' t))
sessionPath (R.Children n o l s i)  = sessionPath (R.NodeAPI Node i ("children?type=" <> show n <> offsetUrl o <> limitUrl l <> orderUrl s))
94
sessionPath (R.NodeAPI Phylo pId p) = "phyloscape?nodeId=" <> (show $ fromMaybe 0 pId) <> p
95
sessionPath (R.RecomputeNgrams nt nId lId)      = "node/" <> (show nId) <> "/ngrams/recompute?" <> (defaultList lId) <> "&ngramsType=" <> (show nt)
96
sessionPath (R.RecomputeListChart ChartBar nt nId lId)   = "node/" <> (show nId) <> "/pie?" <> (defaultList lId) <> "&ngramsType=" <> (show nt)
97 98 99 100 101
sessionPath (R.RecomputeListChart ChartPie nt nId lId)   = "node/" <> (show nId) <> "/pie?" <> (defaultList lId) <> "&ngramsType=" <> (show nt)
sessionPath (R.RecomputeListChart ChartTree nt nId lId)  = "node/" <> (show nId) <> "/tree?" <> (defaultList lId) <> "&ngramsType=" <> (show nt) <> "&listType=" <> show MapTerm
sessionPath (R.RecomputeListChart Histo nt nId lId)      = "node/" <> (show nId) <> "/chart?" <> (defaultList lId) <> "&ngramsType=" <> (show nt)
sessionPath (R.RecomputeListChart Scatter nt nId lId)    = "node/" <> (show nId) <> "/metrics?" <> (defaultList lId) <> "&ngramsType=" <> (show nt)
sessionPath (R.RecomputeListChart _ nt nId lId)          = "node/" <> (show nId) <> "/recompute-chart?" <> (defaultList lId) <> "&ngramsType=" <> (show nt)
102
sessionPath (R.GraphAPI gId p)      = "graph/" <> (show gId) <> "/" <> p
103
sessionPath (R.GetNgrams opts i)    =
104
  base opts.tabType
105
     $ "ngrams?ngramsType=" <> showTabType' opts.tabType
106
    <> limitUrl opts.limit
107
    <> offset opts.offset
108
    <> orderByUrl opts.orderBy
109
    <> foldMap (\x -> if x /= 0 then "&list=" <> show x else "") opts.listIds
110 111 112
    <> foldMap (\x -> "&listType=" <> show x) opts.termListFilter
    <> foldMap termSizeFilter opts.termSizeFilter
    <> search opts.searchQuery
113
  where
114 115
    base (TabCorpus _) = sessionPath <<< R.NodeAPI Node i
    base _             = sessionPath <<< R.NodeAPI Url_Document i
116 117
    offset Nothing = ""
    offset (Just o) = offsetUrl o
118 119 120 121
    termSizeFilter MonoTerm = "&minTermSize=0&maxTermSize=1"
    termSizeFilter MultiTerm = "&minTermSize=2"
    search "" = ""
    search s = "&search=" <> s
122 123 124 125 126 127
sessionPath (R.GetNgramsTableAll opts i) =
  sessionPath $ R.NodeAPI Node i
     $ "ngrams?ngramsType="
    <> showTabType' opts.tabType
    <> foldMap (\x -> "&list=" <> show x) opts.listIds
    <> limitUrl 100000
128 129 130 131 132
sessionPath (R.GetNgramsTableVersion opts i) =
  sessionPath $ R.NodeAPI Node i
     $ "ngrams/version?ngramsType="
    <> showTabType' opts.tabType
    <> "&list=" <> show opts.listId
133 134
    --  $ "ngrams/version?"
    -- <> "list=" <> show opts.listId
135
sessionPath (R.ListDocument lId dId) =
136
  sessionPath $ R.NodeAPI NodeList lId ("document/" <> (show $ fromMaybe 0 dId))
137
sessionPath (R.ListsRoute lId) = "lists/" <> show lId
138
sessionPath (R.PutNgrams t listId termList i) =
139 140 141 142 143
  sessionPath $ R.NodeAPI Node i
      $ "ngrams?ngramsType="
     <> showTabType' t
     <> maybe "" (\x -> "&list=" <> show x) listId
     <> foldMap (\x -> "&listType=" <> show x) termList
144 145
sessionPath (R.PostNgramsChartsAsync i) =
  sessionPath $ R.NodeAPI Node i $ "ngrams/async/charts/update"
146 147 148
sessionPath (R.NodeAPI nt i p) = nodeTypePath nt
                              <> (maybe "" (\i' -> "/" <> show i') i)
                              <> (if p == "" then "" else "/" <> p)
149 150
sessionPath (R.TreeFirstLevel nId p) = nodeTypePath Tree
                                    <> (maybe "" (\nId' -> "/" <> show nId') nId) <> "/first-level" <> p
151 152 153 154 155 156 157 158
sessionPath (R.Search {listId, limit, offset, orderBy} Nothing) =
  sessionPath $ R.NodeAPI Corpus Nothing
     $ "search?list_id=" <> show listId
    <> offsetUrl offset
    <> limitUrl limit
    <> orderUrl orderBy
sessionPath (R.Search {listId, limit, offset, orderBy} (Just corpusId)) =
  sessionPath $ R.NodeAPI Corpus (Just corpusId)
159
     $ "search?list_id=" <> show listId
160 161 162
    <> offsetUrl offset
    <> limitUrl limit
    <> orderUrl orderBy
163 164 165 166 167
-- sessionPath (R.Search {listId, limit, offset, orderBy} (Just corpusId)) =
--     "search/" <> (show corpusId) <> "/list/" <> (show listId) <> "?"
--     <> offsetUrl offset
--     <> limitUrl limit
--     <> orderUrl orderBy
168
sessionPath (R.CorpusMetrics { listId, limit, tabType} i) =
169 170 171 172
  sessionPath $ R.NodeAPI Corpus i
     $ "metrics"
    <> "?ngrams=" <> show listId
    <> "&ngramsType=" <> showTabType' tabType
Nicolas Pouillard's avatar
Nicolas Pouillard committed
173
    <> maybe "" limitUrl limit
174
sessionPath (R.CorpusMetricsHash { listId, tabType} i) =
175
  sessionPath $ R.NodeAPI Corpus i
176
     $ "metrics/hash"
177 178
    <> "?ngrams=" <> show listId
    <> "&ngramsType=" <> showTabType' tabType
179
-- TODO fix this url path
180
sessionPath (R.Chart {chartType, limit, listId, tabType} i) =
181 182 183
  sessionPath $ R.NodeAPI Corpus i
     $ show chartType
    <> "?ngramsType=" <> showTabType' tabType
184 185
    <> "&listType=" <> show MapTerm  -- listId
    <> defaultListAddMaybe listId
186 187 188 189
    where
      limitPath = case limit of
        Just li -> "&limit=" <> show li
        Nothing -> ""
Nicolas Pouillard's avatar
Nicolas Pouillard committed
190
    -- <> maybe "" limitUrl limit
191
sessionPath (R.ChartHash { chartType, listId, tabType } i) =
192 193
  sessionPath $ R.NodeAPI Corpus i
     $ show chartType
194
    <> "/hash?ngramsType=" <> showTabType' tabType
195 196
    <> "&listType=" <> show MapTerm -- listId
    <> defaultListAddMaybe listId
197
-- sessionPath (R.NodeAPI (NodeContact s a i) i) = sessionPath $ "annuaire/" <> show a <> "/contact/" <> show i
198

199

200 201
------- misc routing stuff

202 203 204 205 206 207
defaultList :: Int -> String
defaultList n = if n == 0 then "" else ("list=" <> show n)

defaultListAdd :: Int -> String
defaultListAdd n = "&" <> defaultList n

208 209 210 211
defaultListAddMaybe :: Maybe Int -> String
defaultListAddMaybe Nothing = ""
defaultListAddMaybe (Just l) = "&list=" <> show l

212 213


214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
limitUrl :: Limit -> String
limitUrl l = "&limit=" <> show l

offsetUrl :: Offset -> String
offsetUrl o = "&offset=" <> show o

orderUrl :: forall a. Show a => Maybe a -> String
orderUrl = maybe "" (\x -> "&order=" <> show x)

orderByUrl :: forall a. Show a => Maybe a -> String
orderByUrl = maybe "" (\x -> "&orderBy=" <> show x)

-- nodeTypePath :: NodeType -> Path
-- nodeTypePath = NodeAPI

229
-- instance ToUrl NodeType where
230 231
--   toUrl ec e nt i = toUrl ec e (NodeAPI nt) i

232
-- instance ToUrl Path where
233 234 235 236 237 238
--   toUrl ec e p i = doUrl base path params
--     where
--       base   = endBaseUrl e ec
--       path   = endPathUrl e ec p i
--       params = ""
------------------------------------------------------------