haskell/yesod
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Cleaned up Yesod.Handler function names

Browse Source
This commit is contained in:
Michael Snoyman 2010-06-30 21:16:00 +03:00
parent d34f44fd53
commit 0652fae94f
2 changed files with 18 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
Yesod/Handler.hs
View File

@ -6,7 +6,6 @@
{-# LANGUAGE PackageImports #-} {-# LANGUAGE PackageImports #-}
{-# LANGUAGE TypeFamilies #-} {-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE Rank2Types #-} {-# LANGUAGE Rank2Types #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-} {-# LANGUAGE GeneralizedNewtypeDeriving #-}
--------------------------------------------------------- ---------------------------------------------------------
-- --
@ -22,8 +21,10 @@
-- --
--------------------------------------------------------- ---------------------------------------------------------
module Yesod.Handler module Yesod.Handler
( -- * Handler monad ( -- * Type families
Handler Routes
-- * Handler monad
, Handler
, GHandler , GHandler
-- ** Read information from handler -- ** Read information from handler
, getYesod , getYesod
@ -45,13 +46,13 @@ module Yesod.Handler
-- ** Sending static files -- ** Sending static files
, sendFile , sendFile
-- * Setting headers -- * Setting headers
, addCookie , setCookie
, deleteCookie , deleteCookie
, header , setHeader
, setLanguage , setLanguage
-- * Session -- * Session
, setSession , setSession
, clearSession , deleteSession
-- ** Ultimate destination -- ** Ultimate destination
, setUltDest , setUltDest
, setUltDestString , setUltDestString
@ -63,7 +64,6 @@ module Yesod.Handler
-- * Internal Yesod -- * Internal Yesod
, runHandler , runHandler
, YesodApp (..) , YesodApp (..)
, Routes
, toMasterHandler , toMasterHandler
) where ) where
@ -325,7 +325,7 @@ redirectUltDest :: RedirectType
-> GHandler sub master () -> GHandler sub master ()
redirectUltDest rt def = do redirectUltDest rt def = do
mdest <- lookupSession ultDestKey mdest <- lookupSession ultDestKey
clearSession ultDestKey deleteSession ultDestKey
maybe (redirect rt def) (redirectString rt) mdest maybe (redirect rt def) (redirectString rt) mdest
msgKey :: String msgKey :: String
@ -343,7 +343,7 @@ setMessage = setSession msgKey . L.toString . renderHtml
-- See 'setMessage'. -- See 'setMessage'.
getMessage :: GHandler sub master (Maybe (Html ())) getMessage :: GHandler sub master (Maybe (Html ()))
getMessage = do getMessage = do
clearSession msgKey deleteSession msgKey
fmap (fmap preEscapedString) $ lookupSession msgKey fmap (fmap preEscapedString) $ lookupSession msgKey
-- | Bypass remaining handler code and output the given file. -- | Bypass remaining handler code and output the given file.
@ -373,11 +373,11 @@ invalidArgs = failure . InvalidArgs
------- Headers ------- Headers
-- | Set the cookie on the client. -- | Set the cookie on the client.
addCookie :: Int -- ^ minutes to timeout setCookie :: Int -- ^ minutes to timeout
-> String -- ^ key -> String -- ^ key
-> String -- ^ value -> String -- ^ value
-> GHandler sub master () -> GHandler sub master ()
addCookie a b = addHeader . AddCookie a b setCookie a b = addHeader . AddCookie a b
-- | Unset the cookie on the client. -- | Unset the cookie on the client.
deleteCookie :: String -> GHandler sub master () deleteCookie :: String -> GHandler sub master ()
@ -385,11 +385,11 @@ deleteCookie = addHeader . DeleteCookie
-- | Set the language header. Will show up in 'languages'. -- | Set the language header. Will show up in 'languages'.
setLanguage :: String -> GHandler sub master () setLanguage :: String -> GHandler sub master ()
setLanguage = addCookie 60 langKey setLanguage = setCookie 60 langKey -- FIXME shouldn't we use session for this?
-- | Set an arbitrary header on the client. -- | Set an arbitrary header on the client.
header :: String -> String -> GHandler sub master () setHeader :: String -> String -> GHandler sub master ()
header a = addHeader . Header a setHeader a = addHeader . Header a
-- | Set a variable in the user's session. -- | Set a variable in the user's session.
-- --
@ -402,9 +402,10 @@ setSession :: String -- ^ key
setSession k v = GHandler . lift . lift . lift . tell $ (:) (k, Just v) setSession k v = GHandler . lift . lift . lift . tell $ (:) (k, Just v)
-- | Unsets a session variable. See 'setSession'. -- | Unsets a session variable. See 'setSession'.
clearSession :: String -> GHandler sub master () deleteSession :: String -> GHandler sub master ()
clearSession k = GHandler . lift . lift . lift . tell $ (:) (k, Nothing) deleteSession k = GHandler . lift . lift . lift . tell $ (:) (k, Nothing)
-- | Internal use only, not to be confused with 'setHeader'.
addHeader :: Header -> GHandler sub master () addHeader :: Header -> GHandler sub master ()
addHeader = GHandler . lift . lift . tell . (:) addHeader = GHandler . lift . lift . tell . (:)

2
Yesod/Helpers/Auth.hs
View File

@ -270,7 +270,7 @@ $maybe creds c
getLogout :: YesodAuth master => GHandler Auth master () getLogout :: YesodAuth master => GHandler Auth master ()
getLogout = do getLogout = do
y <- getYesod y <- getYesod
clearSession credsKey deleteSession credsKey
redirectUltDest RedirectTemporary $ defaultDest y redirectUltDest RedirectTemporary $ defaultDest y
-- | Retrieve user credentials. If user is not logged in, redirects to the -- | Retrieve user credentials. If user is not logged in, redirects to the