1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
{-# LANGUAGE DerivingStrategies #-}
{-# LANGUAGE ExplicitNamespaces #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE OverloadedLists #-}
{-# LANGUAGE PartialTypeSignatures #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE TypeApplications #-}
-- Implementation of the API. This module is the main point of the program.
module Server (application) where
import Conduit (MonadTrans (lift), ResourceT)
import Control.Monad (forever, void, when)
import Control.Monad.Extra (maybeM, whenM)
import Control.Monad.IO.Class (MonadIO (liftIO))
import Control.Monad.Logger (NoLoggingT, logWarnN)
import Control.Monad.Reader (forM)
import Control.Monad.Trans.Maybe (MaybeT (..))
import Data.Aeson (FromJSON (parseJSON),
ToJSON (toJSON), ToJSONKey,
genericParseJSON, genericToJSON)
import qualified Data.Aeson as A
import qualified Data.ByteString.Char8 as C8
import Data.Coerce (coerce)
import Data.Functor ((<&>))
import Data.Map (Map)
import qualified Data.Map as M
import Data.Pool (Pool)
import Data.Proxy (Proxy (Proxy))
import Data.Swagger hiding (delete, get)
import Data.Text (Text)
import Data.Time (NominalDiffTime,
UTCTime (utctDay), addUTCTime,
dayOfWeek, diffUTCTime,
getCurrentTime, nominalDay)
import Data.UUID (UUID)
import qualified Data.UUID as UUID
import qualified Data.UUID.V4 as UUID
import Data.Vector (Vector)
import qualified Data.Vector as V
import Database.Persist
import Database.Persist.Postgresql
import Fmt ((+|), (|+))
import GHC.Generics (Generic)
import GTFS
import qualified Network.WebSockets as WS
import Servant (Application,
FromHttpApiData (parseUrlPiece),
Server, err401, err404, serve,
throwError)
import Servant.API (Capture, FromHttpApiData, Get,
JSON, NoContent (..), Post,
ReqBody, type (:<|>) ((:<|>)))
import Servant.Docs (DocCapture (..),
DocQueryParam (..),
ParamKind (..), ToCapture (..),
ToParam (..))
import Servant.Server (Handler, ServerT, hoistServer)
import Servant.Swagger (toSwagger)
import Web.PathPieces (PathPiece)
import API
import Persist
import Server.GTFS_RT (gtfsRealtimeServer)
import Server.Util (Service, ServiceM, runService)
application :: GTFS -> Pool SqlBackend -> IO Application
application gtfs dbpool = do
doMigration dbpool
pure $ serve (Proxy @CompleteAPI) $ hoistServer (Proxy @CompleteAPI) runService $ server gtfs dbpool
-- databaseMigration :: ConnectionString -> IO ()
doMigration pool = runSql pool $
-- TODO: before that, check if the uuid module is enabled
-- in sql: check if SELECT * FROM pg_extension WHERE extname = 'uuid-ossp';
-- returns an empty list
runMigration migrateAll
server :: GTFS -> Pool SqlBackend -> Service CompleteAPI
server gtfs@GTFS{..} dbpool = handleDebugAPI :<|> handleStations :<|> handleTimetable :<|> handleTrip
:<|> handleRegister :<|> handleTripPing :<|> handleWS :<|> handleDebugState :<|>
gtfsRealtimeServer gtfs dbpool
:<|> adminServer gtfs dbpool
where handleStations = pure stations
handleTimetable station maybeDay = do
-- TODO: resolve "overlay" trips (perhaps just additional CalendarDates?)
day <- liftIO $ maybeM (getCurrentTime <&> utctDay) pure (pure maybeDay)
pure
-- don't send stations ending at this station
. M.filter ((==) station . stationId . stopStation . V.last . tripStops)
$ tripsOnDay gtfs day
handleTrip trip = case M.lookup trip trips of
Just res -> pure res
Nothing -> throwError err404
handleRegister tripID = do
-- TODO registration may carry extra information!
expires <- liftIO $ getCurrentTime <&> addUTCTime validityPeriod
RunningTripKey token <- runSql dbpool $ insert (RunningTrip expires False tripID Nothing)
pure token
handleTripPing ping = do
lift $ checkTokenValid dbpool (coerce $ tripPingToken ping)
-- TODO: are these always inserted in order?
runSql dbpool $ insert ping
pure NoContent
handleWS conn = do
-- TODO test this!!
liftIO $ WS.forkPingThread conn 30
forever $ do
msg <- liftIO $ WS.receiveData conn
case A.eitherDecode msg of
Left err -> do
logWarnN ("stray websocket message: "+|show msg|+" (could not decode: "+|err|+")")
liftIO $ WS.sendClose conn (C8.pack err)
Right ping -> do
lift $ checkTokenValid dbpool (coerce $ tripPingToken ping)
void $ runSql dbpool $ insert ping
handleDebugState = do
now <- liftIO getCurrentTime
runSql dbpool $ do
running <- selectList [RunningTripBlocked ==. False, RunningTripExpires >=. now] []
pairs <- forM running $ \(Entity token@(RunningTripKey uuid) _) -> do
entities <- selectList [TripPingToken ==. token] []
pure (uuid, fmap entityVal entities)
pure (M.fromList pairs)
handleDebugAPI = pure $ toSwagger (Proxy @API)
adminServer :: GTFS -> Pool SqlBackend -> Service AdminAPI
adminServer gtfs dbpool =
addAnnounce :<|> delAnnounce :<|> modTripDate Added Cancelled
:<|> modTripDate Cancelled Added :<|> extraTrip
where addAnnounce ann@Announcement{..} = runSql dbpool $ do
AnnouncementKey uuid <- insert ann
pure uuid
delAnnounce uuid = runSql dbpool $ do
delete (AnnouncementKey uuid)
pure NoContent
modTripDate one two tripId day = runSql dbpool $ do
getBy (TripAndDay tripId day) >>= \case
Just (Entity key (ScheduleAmendment _ _ status)) -> do
when (status == two) $ delete key
pure NoContent
Nothing -> do
insert (ScheduleAmendment tripId day one)
pure NoContent
extraTrip = error "unimplemented!"
-- TODO: proper debug logging for expired tokens
checkTokenValid :: Pool SqlBackend -> Token -> Handler ()
checkTokenValid dbpool token = do
trip <- try $ runSql dbpool $ get (coerce token)
when (runningTripBlocked trip)
$ throwError err401
whenM (hasExpired (runningTripExpires trip))
$ throwError err401
where try m = m >>= \case
Just a -> pure a
Nothing -> throwError err404
hasExpired :: MonadIO m => UTCTime -> m Bool
hasExpired limit = do
now <- liftIO getCurrentTime
pure (now > limit)
validityPeriod :: NominalDiffTime
validityPeriod = nominalDay
|
