Irc.Model

This module implements a high-level view of the state of the IRC connection. The library user calls advanceModel to step the IrcConnection as new messages arrive.

IRC Connection model

data IrcConnection

IrcConnection is the state of an IRC connection. It maintains channel membership, user and channel modes, and other connection state.

Constructors

IrcConnection

Fields

• _connNick :: !Identifier
• _connChannels :: !(Map Identifier IrcChannel)
• _connId :: Maybe ByteString
• _connChanTypes :: [Char]
• _connStatusMsg :: [Char]
• _connKnock :: !Bool
• _connNickLen :: !Int
• _connExcepts :: Maybe Char
• _connInvex :: Maybe Char
• _connUsers :: !(Map Identifier IrcUser)
• _connChanModeTypes :: !ModeTypes
• _connUserModeTypes :: !ModeTypes
• _connModes :: !Int
• _connTopicLen :: !Int
• _connMyInfo :: Maybe (ByteString, ByteString)
• _connSasl :: Maybe (ByteString, ByteString)
• _connUmode :: !ByteString
• _connSnoMask :: !ByteString
• _connPhase :: !Phase
• _connPingTime :: !PingStatus

Instances

Read IrcConnection

Methods

readsPrec :: Int -> ReadS IrcConnection

readList :: ReadS [IrcConnection]

readPrec :: ReadPrec IrcConnection

readListPrec :: ReadPrec [IrcConnection]

Show IrcConnection

Methods

showsPrec :: Int -> IrcConnection -> ShowS

show :: IrcConnection -> String

showList :: [IrcConnection] -> ShowS

connNick :: Lens' IrcConnection Identifier

connChannels :: Lens' IrcConnection (Map Identifier IrcChannel)

connId :: Lens' IrcConnection (Maybe ByteString)

connChanModeTypes :: Lens' IrcConnection ModeTypes

connUserModeTypes :: Lens' IrcConnection ModeTypes

connKnock :: Lens' IrcConnection Bool

connNickLen :: Lens' IrcConnection Int

connExcepts :: Lens' IrcConnection (Maybe Char)

connInvex :: Lens' IrcConnection (Maybe Char)

connStatusMsg :: Lens' IrcConnection [Char]

connTopicLen :: Lens' IrcConnection Int

connPhase :: Lens' IrcConnection Phase

connModes :: Lens' IrcConnection Int

connUsers :: Lens' IrcConnection (Map Identifier IrcUser)

connMyInfo :: Lens' IrcConnection (Maybe (ByteString, ByteString))

connSasl :: Lens' IrcConnection (Maybe (ByteString, ByteString))

connUmode :: Lens' IrcConnection ByteString

connSnoMask :: Lens' IrcConnection ByteString

connPingTime :: Lens' IrcConnection PingStatus

defaultIrcConnection :: IrcConnection

IrcConnection value with everything unspecified

Ping information

data PingStatus

Constructors

PingTime Pico

PingSent UTCTime

NoPing

Instances

Read PingStatus

Methods

readsPrec :: Int -> ReadS PingStatus

readList :: ReadS [PingStatus]

readPrec :: ReadPrec PingStatus

readListPrec :: ReadPrec [PingStatus]

Show PingStatus

Methods

showsPrec :: Int -> PingStatus -> ShowS

show :: PingStatus -> String

showList :: [PingStatus] -> ShowS

Phases

data Phase

Constructors

RegistrationPhase

ActivePhase

SaslPhase

Instances

Eq Phase

Methods

(==) :: Phase -> Phase -> Bool

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

Read Phase

Methods

readsPrec :: Int -> ReadS Phase

readList :: ReadS [Phase]

readPrec :: ReadPrec Phase

readListPrec :: ReadPrec [Phase]

Show Phase

Methods

showsPrec :: Int -> Phase -> ShowS

show :: Phase -> String

showList :: [Phase] -> ShowS

IRC Channel model

data IrcChannel

IrcChannel represents the current state of a channel as seen on the connection. It includes all user lists, modes, and other metadata about a channel.

Constructors

IrcChannel

Fields

• _chanTopic :: Maybe (Maybe (Text, ByteString, UTCTime))
• _chanUsers :: !(Map Identifier String)
• _chanModes :: Maybe (Map Char ByteString)
• _chanCreation :: Maybe UTCTime
• _chanMaskLists :: Map Char [IrcMaskEntry]
• _chanUrl :: Maybe ByteString

Instances

Read IrcChannel

Methods

readsPrec :: Int -> ReadS IrcChannel

readList :: ReadS [IrcChannel]

readPrec :: ReadPrec IrcChannel

readListPrec :: ReadPrec [IrcChannel]

Show IrcChannel

Methods

showsPrec :: Int -> IrcChannel -> ShowS

show :: IrcChannel -> String

showList :: [IrcChannel] -> ShowS

chanTopic :: Lens' IrcChannel (Maybe (Maybe (Text, ByteString, UTCTime)))

chanUsers :: Lens' IrcChannel (Map Identifier String)

chanModes :: Lens' IrcChannel (Maybe (Map Char ByteString))

chanCreation :: Lens' IrcChannel (Maybe UTCTime)

chanMaskLists :: Lens' IrcChannel (Map Char [IrcMaskEntry])

chanUrl :: Lens' IrcChannel (Maybe ByteString)

Mode Settings

data ModeTypes

Settings that describe how to interpret channel modes

Constructors

ModeTypes

Fields

• _modesLists :: String
• _modesAlwaysArg :: String
• _modesSetArg :: String
• _modesNeverArg :: String
• _modesPrefixModes :: [(Char, Char)]

Instances

Read ModeTypes

Methods

readsPrec :: Int -> ReadS ModeTypes

readList :: ReadS [ModeTypes]

readPrec :: ReadPrec ModeTypes

readListPrec :: ReadPrec [ModeTypes]

Show ModeTypes

Methods

showsPrec :: Int -> ModeTypes -> ShowS

show :: ModeTypes -> String

showList :: [ModeTypes] -> ShowS

modesLists :: Lens' ModeTypes String

modesAlwaysArg :: Lens' ModeTypes String

modesSetArg :: Lens' ModeTypes String

modesNeverArg :: Lens' ModeTypes String

modesPrefixModes :: Lens' ModeTypes [(Char, Char)]

defaultChanModeTypes :: ModeTypes

The channel modes used by Freenode

defaultUmodeTypes :: ModeTypes

The default UMODE as defined by Freenode

Channel Mask Entry

data IrcMaskEntry

Mask entries are used to represent an entry in a ban list for a channel.

Constructors

IrcMaskEntry

Fields

• _maskEntryMask :: ByteString
• _maskEntryWho :: ByteString
• _maskEntryStamp :: UTCTime

Instances

Read IrcMaskEntry

Methods

readsPrec :: Int -> ReadS IrcMaskEntry

readList :: ReadS [IrcMaskEntry]

readPrec :: ReadPrec IrcMaskEntry

readListPrec :: ReadPrec [IrcMaskEntry]

Show IrcMaskEntry

Methods

showsPrec :: Int -> IrcMaskEntry -> ShowS

show :: IrcMaskEntry -> String

showList :: [IrcMaskEntry] -> ShowS

maskEntryMask :: Lens' IrcMaskEntry ByteString

maskEntryWho :: Lens' IrcMaskEntry ByteString

maskEntryStamp :: Lens' IrcMaskEntry UTCTime

User metadata

data IrcUser

IrcUser is the type of user-level metadata tracked for the users visible on the current IRC connection.

Constructors

IrcUser

Fields

• _usrAway :: !Bool
• _usrAccount :: !(Maybe ByteString)
• _usrHost :: !(Maybe ByteString)

Instances

Read IrcUser

Methods

readsPrec :: Int -> ReadS IrcUser

readList :: ReadS [IrcUser]

readPrec :: ReadPrec IrcUser

readListPrec :: ReadPrec [IrcUser]

Show IrcUser

Methods

showsPrec :: Int -> IrcUser -> ShowS

show :: IrcUser -> String

showList :: [IrcUser] -> ShowS

usrAway :: Lens' IrcUser Bool

usrAccount :: Lens' IrcUser (Maybe ByteString)

usrHost :: Lens' IrcUser (Maybe ByteString)

defaultIrcUser :: IrcUser

This represents the metadata of an unknown user.

Model execution

runLogic :: (Functor m, Monad m) => UTCTime -> (forall r. LogicOp r -> m r) -> Logic a -> m (Either String a)

Execute the Logic value using a given operation for sending and recieving IRC messages.

data LogicOp r

Constructors

Expect (MsgFromServer -> r)

Emit ByteString r

Record Identifier IrcMessage r

Instances

Functor LogicOp

Methods

fmap :: (a -> b) -> LogicOp a -> LogicOp b

(<$) :: a -> LogicOp b -> LogicOp a

data Logic a

Instances

Monad Logic

Methods

(>>=) :: Logic a -> (a -> Logic b) -> Logic b

(>>) :: Logic a -> Logic b -> Logic b

return :: a -> Logic a

fail :: String -> Logic a

Functor Logic

Methods

fmap :: (a -> b) -> Logic a -> Logic b

(<$) :: a -> Logic b -> Logic a

Applicative Logic

Methods

pure :: a -> Logic a

(<*>) :: Logic (a -> b) -> Logic a -> Logic b

(*>) :: Logic a -> Logic b -> Logic b

(<*) :: Logic a -> Logic b -> Logic a

General functionality

advanceModel :: MsgFromServer -> IrcConnection -> Logic IrcConnection

Primary state machine step function. Call this function with a timestamp and a server message to update the IrcConnection state. If additional messages are required they will be requested via the Logic type.

isChannelName :: Identifier -> IrcConnection -> Bool

Predicate for identifiers to identify which represent channel names. Channel prefixes are configurable, but the most common is #

isNickName :: Identifier -> IrcConnection -> Bool

Predicate for identifiers to identify which represent nicknames

isMyNick :: Identifier -> IrcConnection -> Bool

Predicate to determine if a given identifier is the primary nick for the given connection.

splitStatusMsg :: Identifier -> IrcConnection -> (String, Identifier)

splitModes

Arguments

:: ModeTypes

mode interpretation

-> ByteString

modes

-> [ByteString]

arguments

-> Maybe [(Bool, Char, ByteString)]

Split up a mode change command and arguments into individual changes given a configuration.

unsplitModes :: [(Bool, Char, ByteString)] -> [ByteString]

nickHasModeInChannel

Arguments

:: Identifier

nick

-> Char

mode

-> Identifier

channel

-> IrcConnection

-> Bool

channelHasMode

Arguments

:: Identifier

channel

-> Char

mode

-> IrcConnection

-> Bool