Safe Haskell	Safe-Inferred
Language	Haskell2010

Web.Scim.Filter

Contents

Filter type
Constructing filters

Description

A query might specify a filter that should be applied to the results before returning them. This module implements a very limited subset of the specification: https://tools.ietf.org/html/rfc7644#section-3.4.2.2.

Supported:

All comparison operators (eq, le, etc)
The userName attribute

Not supported:

The pr operator
Boolean operators
Combined filters
Fully qualified attribute names (schema prefixes, attribute paths)

Synopsis

data Filter = FilterAttrCompare AttrPath CompareOp CompValue
parseFilter :: [Schema] -> Text -> Either Text Filter
renderFilter :: Filter -> Text
data CompValue
- = ValNull
- | ValBool Bool
- | ValNumber Scientific
- | ValString Text
data CompareOp
- = OpEq
- | OpNe
- | OpCo
- | OpSw
- | OpEw
- | OpGt
- | OpGe
- | OpLt
- | OpLe
data AttrPath = AttrPath (Maybe Schema) AttrName (Maybe SubAttr)
data ValuePath = ValuePath AttrPath Filter
newtype SubAttr = SubAttr AttrName
pAttrPath :: [Schema] -> Parser AttrPath
pValuePath :: [Schema] -> Parser ValuePath
pSubAttr :: Parser SubAttr
pFilter :: [Schema] -> Parser Filter
rAttrPath :: AttrPath -> Text
rCompareOp :: CompareOp -> Text
rValuePath :: ValuePath -> Text
rSubAttr :: SubAttr -> Text
compareStr :: CompareOp -> Text -> Text -> Bool
topLevelAttrPath :: Text -> AttrPath

Filter type

data Filter Source #

A filter.

Our representation of filters is lax and doesn't attempt to ensure validity on the type level. If a filter does something silly (e.g. tries to compare a username with a boolean), it will be caught during filtering and an appropriate error message will be thrown (see filterUser).

TODO(arianvp): Implement the following grammar fully if we want to support more complex filters

FILTER = attrExp logExp valuePath / *1"not" "(" FILTER ")"

Constructors

FilterAttrCompare AttrPath CompareOp CompValue

Compare the attribute value with a literal

Instances

Instances details

Show Filter Source #
Instance details Defined in Web.Scim.Filter Methods showsPrec :: Int -> Filter -> ShowS # show :: Filter -> String # showList :: [Filter] -> ShowS #
Eq Filter Source #
Instance details Defined in Web.Scim.Filter Methods (==) :: Filter -> Filter -> Bool # (/=) :: Filter -> Filter -> Bool #
FromHttpApiData Filter Source #	We currently only support filtering on core user schema
Instance details Defined in Web.Scim.Filter Methods parseUrlPiece :: Text -> Either Text Filter # parseHeader :: ByteString -> Either Text Filter # parseQueryParam :: Text -> Either Text Filter #
ToHttpApiData Filter Source #
Instance details Defined in Web.Scim.Filter Methods toUrlPiece :: Filter -> Text # toEncodedUrlPiece :: Filter -> Builder # toHeader :: Filter -> ByteString # toQueryParam :: Filter -> Text # toEncodedQueryParam :: Filter -> Builder #

parseFilter :: [Schema] -> Text -> Either Text Filter Source #

PATH = attrPath / valuePath [subAttr]

Currently we don't support matching on lists in paths as we currently don't support filtering on arbitrary attributes yet e.g. "path":"members[value eq "2819c223-7f76-453a-919d-413861904646"].displayName" is not supported

Parse a filter. Spaces surrounding the filter will be stripped.

If parsing fails, returns a Left with an error description.

Note: this parser is written with Attoparsec because I don't know how to lift an Attoparsec parser (from Aeson) to Megaparsec

renderFilter :: Filter -> Text Source #

Render a filter according to the SCIM spec.

Constructing filters

data CompValue Source #

A value type. Attributes are compared against literal values.

Constructors

ValNull
ValBool Bool
ValNumber Scientific
ValString Text

Instances

Instances details

Show CompValue Source #
Instance details Defined in Web.Scim.Filter Methods showsPrec :: Int -> CompValue -> ShowS # show :: CompValue -> String # showList :: [CompValue] -> ShowS #
Eq CompValue Source #
Instance details Defined in Web.Scim.Filter Methods (==) :: CompValue -> CompValue -> Bool # (/=) :: CompValue -> CompValue -> Bool #
Ord CompValue Source #
Instance details Defined in Web.Scim.Filter Methods compare :: CompValue -> CompValue -> Ordering # (<) :: CompValue -> CompValue -> Bool # (<=) :: CompValue -> CompValue -> Bool # (>) :: CompValue -> CompValue -> Bool # (>=) :: CompValue -> CompValue -> Bool # max :: CompValue -> CompValue -> CompValue # min :: CompValue -> CompValue -> CompValue #

data CompareOp Source #

A comparison operator.

Constructors

OpEq	Equal
OpNe	Not equal
OpCo	Contains
OpSw	Starts with
OpEw	Ends with
OpGt	Greater than
OpGe	Greater than or equal to
OpLt	Less than
OpLe	Less than or equal to

Instances

Instances details

Bounded CompareOp Source #
Instance details Defined in Web.Scim.Filter Methods minBound :: CompareOp # maxBound :: CompareOp #
Enum CompareOp Source #
Instance details Defined in Web.Scim.Filter Methods succ :: CompareOp -> CompareOp # pred :: CompareOp -> CompareOp # toEnum :: Int -> CompareOp # fromEnum :: CompareOp -> Int # enumFrom :: CompareOp -> [CompareOp] # enumFromThen :: CompareOp -> CompareOp -> [CompareOp] # enumFromTo :: CompareOp -> CompareOp -> [CompareOp] # enumFromThenTo :: CompareOp -> CompareOp -> CompareOp -> [CompareOp] #
Show CompareOp Source #
Instance details Defined in Web.Scim.Filter Methods showsPrec :: Int -> CompareOp -> ShowS # show :: CompareOp -> String # showList :: [CompareOp] -> ShowS #
Eq CompareOp Source #
Instance details Defined in Web.Scim.Filter Methods (==) :: CompareOp -> CompareOp -> Bool # (/=) :: CompareOp -> CompareOp -> Bool #
Ord CompareOp Source #
Instance details Defined in Web.Scim.Filter Methods compare :: CompareOp -> CompareOp -> Ordering # (<) :: CompareOp -> CompareOp -> Bool # (<=) :: CompareOp -> CompareOp -> Bool # (>) :: CompareOp -> CompareOp -> Bool # (>=) :: CompareOp -> CompareOp -> Bool # max :: CompareOp -> CompareOp -> CompareOp # min :: CompareOp -> CompareOp -> CompareOp #

data AttrPath Source #

attrPath = [URI ":"] ATTRNAME *1subAtt

Constructors

AttrPath (Maybe Schema) AttrName (Maybe SubAttr)

Instances

Instances details

Show AttrPath Source #
Instance details Defined in Web.Scim.Filter Methods showsPrec :: Int -> AttrPath -> ShowS # show :: AttrPath -> String # showList :: [AttrPath] -> ShowS #
Eq AttrPath Source #
Instance details Defined in Web.Scim.Filter Methods (==) :: AttrPath -> AttrPath -> Bool # (/=) :: AttrPath -> AttrPath -> Bool #

data ValuePath Source #

valuePath = attrPath "[" valFilter "]" TODO(arianvp): This is a slight simplification at the moment as we don't support the complete Filter grammar. This should be a valFilter, not a FILTER.

Constructors

ValuePath AttrPath Filter

Instances

Instances details

Show ValuePath Source #
Instance details Defined in Web.Scim.Filter Methods showsPrec :: Int -> ValuePath -> ShowS # show :: ValuePath -> String # showList :: [ValuePath] -> ShowS #
Eq ValuePath Source #
Instance details Defined in Web.Scim.Filter Methods (==) :: ValuePath -> ValuePath -> Bool # (/=) :: ValuePath -> ValuePath -> Bool #

newtype SubAttr Source #

subAttr = "." ATTRNAME

Constructors

SubAttr AttrName

Instances

Instances details

IsString SubAttr Source #
Instance details Defined in Web.Scim.Filter Methods fromString :: String -> SubAttr #
Show SubAttr Source #
Instance details Defined in Web.Scim.Filter Methods showsPrec :: Int -> SubAttr -> ShowS # show :: SubAttr -> String # showList :: [SubAttr] -> ShowS #
Eq SubAttr Source #
Instance details Defined in Web.Scim.Filter Methods (==) :: SubAttr -> SubAttr -> Bool # (/=) :: SubAttr -> SubAttr -> Bool #

pAttrPath :: [Schema] -> Parser AttrPath Source #

ATTRNAME  = ALPHA *(nameChar)
attrPath  = [URI ":"] ATTRNAME *1subAtt

pValuePath :: [Schema] -> Parser ValuePath Source #

valuePath = attrPath "[" valFilter "]"

pSubAttr :: Parser SubAttr Source #

subAttr = "." ATTRNAME

pFilter :: [Schema] -> Parser Filter Source #

Filter parser.

rAttrPath :: AttrPath -> Text Source #

rCompareOp :: CompareOp -> Text Source #

Comparison operator renderer.

rValuePath :: ValuePath -> Text Source #

rSubAttr :: SubAttr -> Text Source #

compareStr :: CompareOp -> Text -> Text -> Bool Source #

Execute a comparison operator.

topLevelAttrPath :: Text -> AttrPath Source #

Smart constructor that refers to a toplevel field with default schema