Safe Haskell	None
Language	Haskell2010

Irc.Model

Contents

IRC Connection model
Phases
IRC Channel model
Mode Settings
Channel Mask Entry
User metadata
Model execution
General functionality

Description

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.

Synopsis

IRC Connection model

data IrcConnection Source

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

Instances

Read IrcConnection Source
Show IrcConnection Source

connNick :: Lens' IrcConnection Identifier Source

connChannels :: Lens' IrcConnection (Map Identifier IrcChannel) Source

connId :: Lens' IrcConnection (Maybe ByteString) Source

connChanModeTypes :: Lens' IrcConnection ModeTypes Source

connUserModeTypes :: Lens' IrcConnection ModeTypes Source

connKnock :: Lens' IrcConnection Bool Source

connNickLen :: Lens' IrcConnection Int Source

connExcepts :: Lens' IrcConnection (Maybe Char) Source

connInvex :: Lens' IrcConnection (Maybe Char) Source

connStatusMsg :: Lens' IrcConnection [Char] Source

connTopicLen :: Lens' IrcConnection Int Source

connPhase :: Lens' IrcConnection Phase Source

connModes :: Lens' IrcConnection Int Source

connUsers :: Lens' IrcConnection (Map Identifier IrcUser) Source

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

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

connUmode :: Lens' IrcConnection ByteString Source

connSnoMask :: Lens' IrcConnection ByteString Source

defaultIrcConnection :: IrcConnection Source

IrcConnection value with everything unspecified

Phases

data Phase Source

Constructors

RegistrationPhase
ActivePhase
SaslPhase

Instances

Eq Phase Source
Read Phase Source
Show Phase Source

IRC Channel model

data IrcChannel Source

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 Source
Show IrcChannel Source

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

chanUsers :: Lens' IrcChannel (Map Identifier String) Source

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

chanCreation :: Lens' IrcChannel (Maybe UTCTime) Source

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

chanUrl :: Lens' IrcChannel (Maybe ByteString) Source

Mode Settings

data ModeTypes Source

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 Source
Show ModeTypes Source

modesLists :: Lens' ModeTypes String Source

modesAlwaysArg :: Lens' ModeTypes String Source

modesSetArg :: Lens' ModeTypes String Source

modesNeverArg :: Lens' ModeTypes String Source

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

defaultChanModeTypes :: ModeTypes Source

The channel modes used by Freenode

defaultUmodeTypes :: ModeTypes Source

The default UMODE as defined by Freenode

Channel Mask Entry

data IrcMaskEntry Source

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 Source
Show IrcMaskEntry Source

maskEntryMask :: Lens' IrcMaskEntry ByteString Source

maskEntryWho :: Lens' IrcMaskEntry ByteString Source

maskEntryStamp :: Lens' IrcMaskEntry UTCTime Source

User metadata

data IrcUser Source

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 Source
Show IrcUser Source

usrAway :: Lens' IrcUser Bool Source

usrAccount :: Lens' IrcUser (Maybe ByteString) Source

usrHost :: Lens' IrcUser (Maybe ByteString) Source

defaultIrcUser :: IrcUser Source

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) Source

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

data LogicOp r Source

Constructors

Expect (MsgFromServer -> r)
Emit ByteString r
Record Identifier IrcMessage r

Instances

Functor LogicOp Source

data Logic a Source

Instances

Monad Logic Source
Functor Logic Source
Applicative Logic Source

General functionality

advanceModel :: MsgFromServer -> IrcConnection -> Logic IrcConnection Source

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 Source

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

isNickName :: Identifier -> IrcConnection -> Bool Source

Predicate for identifiers to identify which represent nicknames

isMyNick :: Identifier -> IrcConnection -> Bool Source

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

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

splitModes Source

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] Source

nickHasModeInChannel Source

Arguments

:: Identifier	nick
-> Char	mode
-> Identifier	channel
-> IrcConnection
-> Bool

channelHasMode Source

Arguments

:: Identifier	channel
-> Char	mode
-> IrcConnection
-> Bool