-
Notifications
You must be signed in to change notification settings - Fork 0
/
State.hs
330 lines (282 loc) · 13.7 KB
/
State.hs
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
{-
Copyright (C) 2008 John MacFarlane <[email protected]>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-}
{- Functions for maintaining user list and session state.
-}
module Gitit.State where
import qualified Data.Map as M
import System.Random (randomRIO)
import Data.Digest.Pure.SHA (sha512, showDigest)
import qualified Data.ByteString.Lazy.UTF8 as L (fromString)
import qualified Data.ByteString.UTF8 as B (ByteString, fromString, toString, length)
import System.Time (getClockTime, ClockTime)
import Data.IORef
import System.IO.Unsafe (unsafePerformIO)
import System.Directory (doesFileExist)
import System.FilePath ((</>))
import Control.Monad.Trans (MonadIO(), liftIO)
import Control.Monad (replicateM, liftM, when)
import Control.Exception (try, throwIO)
import Data.FileStore
import Data.List (intercalate, minimumBy)
import Data.Ord (comparing)
import Data.Maybe (mapMaybe)
import Text.XHtml (Html, renderHtmlFragment, primHtml)
import qualified Text.StringTemplate as T
import Gitit.Server (readMimeTypesFile, Web)
import Text.Pandoc (Pandoc)
import System.Log.Logger (Priority(..), logM)
appstate :: IORef AppState
appstate = unsafePerformIO $ newIORef $ AppState { sessions = undefined
, users = undefined
, config = undefined
, filestore = undefined
, mimeMap = undefined
, cache = undefined
, template = undefined
, jsMath = undefined
, plugins = undefined }
initializeAppState :: MonadIO m => Config -> M.Map String User -> T.StringTemplate String -> m ()
initializeAppState conf users' templ = do
mimeMapFromFile <- liftIO $ readMimeTypesFile (mimeTypesFile conf)
jsMathExists <- liftIO $ doesFileExist $ staticDir conf </> "js" </> "jsMath" </> "easy" </> "load.js"
updateAppState $ \s -> s { sessions = Sessions M.empty
, users = users'
, config = conf
, filestore = case repository conf of
Git fs -> gitFileStore fs
Darcs fs -> darcsFileStore fs
, mimeMap = mimeMapFromFile
, cache = emptyCache
, template = templ
, jsMath = jsMathExists
, plugins = [] }
updateAppState :: MonadIO m => (AppState -> AppState) -> m ()
updateAppState fn = liftIO $! atomicModifyIORef appstate $ \st -> (fn st, ())
queryAppState :: MonadIO m => (AppState -> a) -> m a
queryAppState fn = liftIO $! readIORef appstate >>= return . fn
data Repository = Git FilePath
| Darcs FilePath
deriving (Read, Show)
data PageType = Markdown | RST
deriving (Read, Show)
-- | Data structure for information read from config file.
data Config = Config {
repository :: Repository, -- file store for pages
defaultPageType :: PageType, -- the default page markup type for this wiki
userFile :: FilePath, -- path of users database
templateFile :: FilePath, -- path of page template file
logFile :: FilePath, -- path of server log file
logLevel :: Priority, -- severity filter for log messages (DEBUG, INFO, NOTICE,
-- WARNING, ERROR, CRITICAL, ALERT, EMERGENCY)
staticDir :: FilePath, -- path of static directory
pluginModules :: [String], -- names of plugin modules to load
tableOfContents :: Bool, -- should each page have an automatic table of contents?
maxUploadSize :: Integer, -- maximum size of pages and file uploads
portNumber :: Int, -- port number to serve content on
debugMode :: Bool, -- should debug info be printed to the console?
frontPage :: String, -- the front page of the wiki
noEdit :: [String], -- pages that cannot be edited through the web interface
noDelete :: [String], -- pages that cannot be deleted through the web interface
accessQuestion :: Maybe (String, [String]), -- if Nothing, then anyone can register for an account.
-- if Just (prompt, answers), then a user will be given the prompt
-- and must give one of the answers in order to register.
useRecaptcha :: Bool, -- use ReCAPTCHA service to provide captchas for user registration.
recaptchaPublicKey :: String,
recaptchaPrivateKey :: String,
maxCacheSize :: Integer, -- maximum size in bytes of in-memory page cache
mimeTypesFile :: FilePath -- path of file associating mime types with file extensions
} deriving (Read, Show)
defaultConfig :: Config
defaultConfig = Config {
repository = Git "wikidata",
defaultPageType = Markdown,
userFile = "gitit-users",
templateFile = "template.html",
logFile = "gitit.log",
logLevel = INFO,
staticDir = "static",
pluginModules = [],
tableOfContents = True,
maxUploadSize = 10 * 1024 * 1024,
portNumber = 5001,
debugMode = False,
frontPage = "Front Page",
noEdit = ["Help"],
noDelete = ["Help", "Front Page"],
accessQuestion = Nothing,
useRecaptcha = False,
recaptchaPublicKey = "",
recaptchaPrivateKey = "",
maxCacheSize = 2 * 1024 * 1024,
mimeTypesFile = "/etc/mime.types"
}
type SessionKey = Integer
data SessionData = SessionData {
sessionUser :: String
} deriving (Read,Show,Eq)
data Sessions a = Sessions {unsession::M.Map SessionKey a}
deriving (Read,Show,Eq)
-- Password salt hashedPassword
data Password = Password { pSalt :: String, pHashed :: String }
deriving (Read,Show,Eq)
data User = User {
uUsername :: String,
uPassword :: Password,
uEmail :: String
} deriving (Show,Read)
data AppState = AppState {
sessions :: Sessions SessionData,
users :: M.Map String User,
config :: Config,
filestore :: FileStore,
mimeMap :: M.Map String String,
cache :: Cache,
template :: T.StringTemplate String,
jsMath :: Bool,
plugins :: [Plugin]
}
-- later other types of plugin can be added
data Plugin = PageTransform (AppState -> Pandoc -> Web Pandoc)
getPageTransforms :: Web [AppState -> Pandoc -> Web Pandoc]
getPageTransforms = liftM (mapMaybe pageTransform) $ queryAppState plugins
where pageTransform (PageTransform x) = Just x
-- pageTransform _ = Nothing
data CachedPage = CachedPage {
cpContents :: B.ByteString
, cpRevisionId :: RevisionId
, cpLastAccessTime :: ClockTime
} deriving Show
data Cache = Cache {
cachePages :: M.Map String CachedPage
, cacheSize :: Integer
}
emptyCache :: Cache
emptyCache = Cache M.empty 0
debugMessage :: MonadIO m => String -> m ()
debugMessage msg = do
level <- liftM logLevel getConfig
when (level == DEBUG) $ liftIO $ logM "gitit" DEBUG msg
updateCachedPageTimestamp :: MonadIO m => Cache -> String -> m ()
updateCachedPageTimestamp cache' page = do
now <- liftIO getClockTime
let setTimeStamp Nothing = Nothing
setTimeStamp (Just cp) = Just cp{ cpLastAccessTime = now }
let newcache = cache'{ cachePages = M.alter setTimeStamp page (cachePages cache') }
updateAppState $ \s -> s {cache = newcache }
lookupCache :: MonadIO m => String -> (Maybe RevisionId) -> m (Maybe Html)
lookupCache file (Just revid) = do
c <- queryAppState cache
fs <- getFileStore
case M.lookup file (cachePages c) of
Just cp | idsMatch fs (cpRevisionId cp) revid -> do
debugMessage $ "Retrieving " ++ file ++ " from cache."
updateCachedPageTimestamp c file
return $ Just $ primHtml $ B.toString $ cpContents cp
_ -> return Nothing
lookupCache file Nothing = do
fs <- getFileStore
latestRes <- liftIO $ try (latest fs file)
case latestRes of
Right latestid -> lookupCache file (Just latestid)
Left NotFound -> return Nothing
Left e -> liftIO $ throwIO e
cacheContents :: MonadIO m => String -> RevisionId -> Html -> m ()
cacheContents file revid contents = do
c <- queryAppState cache
let oldsize = case M.lookup file (cachePages c) of
Just cp -> fromIntegral $ B.length $ cpContents cp
Nothing -> 0
let contentsBS = B.fromString $! renderHtmlFragment contents
let newsize = fromIntegral (B.length contentsBS)
maxCacheSize' <- liftM maxCacheSize getConfig
if newsize > maxCacheSize'
then debugMessage $ "Not caching page " ++ file ++ " because it is bigger than the maximum cache size."
else do
now <- liftIO getClockTime
let newpage = CachedPage { cpContents = contentsBS
, cpRevisionId = revid
, cpLastAccessTime = now }
let newcache = c{ cachePages = M.insert file newpage (cachePages c), cacheSize = cacheSize c + newsize - oldsize }
newcachePruned <- pruneCache maxCacheSize' newcache
debugMessage $ "Updating cache with " ++ file ++ ". Total cache size = " ++ show (cacheSize newcachePruned)
updateAppState $ \s -> s { cache = newcachePruned }
pruneCache :: MonadIO m => Integer -> Cache -> m Cache
pruneCache maxSize c =
if cacheSize c < maxSize
then return c
else dropOldest c >>= pruneCache maxSize
dropOldest :: MonadIO m => Cache -> m Cache
dropOldest c = do
let pgs = M.toList $ cachePages c
let (oldestFile, oldestCp) = minimumBy (comparing (cpLastAccessTime . snd)) pgs
let oldestSize = fromIntegral $ B.length $ cpContents oldestCp
debugMessage $ "Removing " ++ oldestFile ++ " (" ++ show oldestSize ++ " bytes) from cache to keep size under limit."
return $ c{ cachePages = M.delete oldestFile (cachePages c), cacheSize = cacheSize c - oldestSize }
mkUser :: String -- username
-> String -- email
-> String -- unhashed password
-> IO User
mkUser uname email pass = do
salt <- genSalt
return $ User { uUsername = uname,
uPassword = Password { pSalt = salt, pHashed = hashPassword salt pass },
uEmail = email }
genSalt :: IO String
genSalt = replicateM 32 $ randomRIO ('0','z')
hashPassword :: String -> String -> String
hashPassword salt pass = showDigest $ sha512 $ L.fromString $ salt ++ pass
authUser :: MonadIO m => String -> String -> m Bool
authUser name pass = do
users' <- queryAppState users
case M.lookup name users' of
Just u -> do
let salt = pSalt $ uPassword u
let hashed = pHashed $ uPassword u
return $ hashed == hashPassword salt pass
Nothing -> return False
isUser :: MonadIO m => String -> m Bool
isUser name = liftM (M.member name) $ queryAppState users
addUser :: MonadIO m => String -> User -> m ()
addUser uname user = updateAppState (\s -> s { users = M.insert uname user (users s) }) >>
liftIO writeUserFile
delUser :: MonadIO m => String -> m ()
delUser uname = updateAppState (\s -> s { users = M.delete uname (users s) }) >>
liftIO writeUserFile
writeUserFile :: IO ()
writeUserFile = do
conf <- getConfig
usrs <- queryAppState users
liftIO $ writeFile (userFile conf) $ "[" ++ intercalate "\n," (map show $ M.toList usrs) ++ "\n]"
getUser :: MonadIO m => String -> m (Maybe User)
getUser uname = liftM (M.lookup uname) $ queryAppState users
isSession :: MonadIO m => SessionKey -> m Bool
isSession key = liftM (M.member key . unsession) $ queryAppState sessions
setSession :: MonadIO m => SessionKey -> SessionData -> m ()
setSession key u = updateAppState $ \s -> s { sessions = Sessions . M.insert key u . unsession $ sessions s }
newSession :: MonadIO m => SessionData -> m SessionKey
newSession u = do
key <- liftIO $ randomRIO (0, 1000000000)
setSession key u
return key
delSession :: MonadIO m => SessionKey -> m ()
delSession key = updateAppState $ \s -> s { sessions = Sessions . M.delete key . unsession $ sessions s }
getSession :: MonadIO m => SessionKey -> m (Maybe SessionData)
getSession key = queryAppState $ M.lookup key . unsession . sessions
getConfig :: MonadIO m => m Config
getConfig = queryAppState config
getFileStore :: MonadIO m => m FileStore
getFileStore = queryAppState filestore
getDefaultPageType :: MonadIO m => m PageType
getDefaultPageType = liftM defaultPageType (queryAppState config)