Hledger.Web.WebOptions

Documentation

packageversion :: PackageVersion

progname :: ProgramName

The name of this program's executable.

prognameandversion :: String

Generate the version string for this program. The template haskell call is here rather than in Hledger.Cli.Version to avoid wasteful recompilation.

webflags :: [Flag RawOpts]

webmode :: Mode RawOpts

data WebOpts

Constructors

WebOpts

Fields

• serve_ :: !Bool
• serve_api_ :: !Bool
• cors_ :: !(Maybe String)
• host_ :: !String
• port_ :: !Int
• base_url_ :: !String
• file_url_ :: !(Maybe String)
• allow_ :: !AccessLevel
• cliopts_ :: !CliOpts
• socket_ :: !(Maybe String)

Instances

Show WebOpts

Defined in Hledger.Web.WebOptions

Methods

showsPrec :: Int -> WebOpts -> ShowS

show :: WebOpts -> String

showList :: [WebOpts] -> ShowS

Default WebOpts

Defined in Hledger.Web.WebOptions

Methods

def :: WebOpts

defwebopts :: WebOpts

rawOptsToWebOpts :: RawOpts -> IO WebOpts

checkWebOpts :: WebOpts -> WebOpts

getHledgerWebOpts :: IO WebOpts

data Permission

Constructors

ViewPermission

allow viewing things (read only)

AddPermission

allow adding transactions, or more generally allow appending text to input files

EditPermission

allow editing input files

Instances

Bounded Permission

Defined in Hledger.Web.WebOptions

Methods

minBound :: Permission

maxBound :: Permission

Enum Permission

Defined in Hledger.Web.WebOptions

Methods

succ :: Permission -> Permission

pred :: Permission -> Permission

toEnum :: Int -> Permission

fromEnum :: Permission -> Int

enumFrom :: Permission -> [Permission]

enumFromThen :: Permission -> Permission -> [Permission]

enumFromTo :: Permission -> Permission -> [Permission]

enumFromThenTo :: Permission -> Permission -> Permission -> [Permission]

Show Permission

Defined in Hledger.Web.WebOptions

Methods

showsPrec :: Int -> Permission -> ShowS

show :: Permission -> String

showList :: [Permission] -> ShowS

Eq Permission

Defined in Hledger.Web.WebOptions

Methods

(==) :: Permission -> Permission -> Bool

(/=) :: Permission -> Permission -> Bool

Ord Permission

Defined in Hledger.Web.WebOptions

Methods

compare :: Permission -> Permission -> Ordering

(<) :: Permission -> Permission -> Bool

(<=) :: Permission -> Permission -> Bool

(>) :: Permission -> Permission -> Bool

(>=) :: Permission -> Permission -> Bool

max :: Permission -> Permission -> Permission

min :: Permission -> Permission -> Permission

parsePermission :: ByteString -> Either Text Permission

showPermission :: Permission -> String

Convert to the lower case permission name.

data AccessLevel

For the --allow option: how much access to allow to hledger-web users ?

Constructors

ViewAccess

view permission only

AddAccess

view and add permissions

EditAccess

view, add and edit permissions

SandstormAccess

the permissions specified by the X-Sandstorm-Permissions HTTP request header

Instances

Bounded AccessLevel

Defined in Hledger.Web.WebOptions

Methods

minBound :: AccessLevel

maxBound :: AccessLevel

Enum AccessLevel

Defined in Hledger.Web.WebOptions

Methods

succ :: AccessLevel -> AccessLevel

pred :: AccessLevel -> AccessLevel

toEnum :: Int -> AccessLevel

fromEnum :: AccessLevel -> Int

enumFrom :: AccessLevel -> [AccessLevel]

enumFromThen :: AccessLevel -> AccessLevel -> [AccessLevel]

enumFromTo :: AccessLevel -> AccessLevel -> [AccessLevel]

enumFromThenTo :: AccessLevel -> AccessLevel -> AccessLevel -> [AccessLevel]

Show AccessLevel

Defined in Hledger.Web.WebOptions

Methods

showsPrec :: Int -> AccessLevel -> ShowS

show :: AccessLevel -> String

showList :: [AccessLevel] -> ShowS

Eq AccessLevel

Defined in Hledger.Web.WebOptions

Methods

(==) :: AccessLevel -> AccessLevel -> Bool

(/=) :: AccessLevel -> AccessLevel -> Bool

Ord AccessLevel

Defined in Hledger.Web.WebOptions

Methods

compare :: AccessLevel -> AccessLevel -> Ordering

(<) :: AccessLevel -> AccessLevel -> Bool

(<=) :: AccessLevel -> AccessLevel -> Bool

(>) :: AccessLevel -> AccessLevel -> Bool

(>=) :: AccessLevel -> AccessLevel -> Bool

max :: AccessLevel -> AccessLevel -> AccessLevel

min :: AccessLevel -> AccessLevel -> AccessLevel

parseAccessLevel :: String -> Either String AccessLevel

accessLevelToPermissions :: AccessLevel -> [Permission]

Convert an --allow access level to the permissions used internally. SandstormAccess generates an empty list, to be filled in later.

simplePolicyWithOrigin :: Origin -> CorsResourcePolicy

corsPolicyFromString :: String -> Middleware

corsPolicy :: WebOpts -> Application -> Application