#include <inspircd.h>

Public Member Functions
User *	FindUUID (const std::string &uid)

time_t	Time ()

long	Time_ns ()

void	UpdateTime ()

std::string	GenRandomStr (unsigned int length, bool printable=true)

unsigned long	GenRandomInt (unsigned long max)

bool	BindPort (ConfigTag tag, const irc::sockets::sockaddrs &sa, std::vector< ListenSocket > &old_ports)

size_t	BindPorts (FailedPortList &failed_ports)

User *	FindNick (const std::string &nick)

User *	FindNickOnly (const std::string &nick)

Channel *	FindChan (const std::string &chan)

chan_hash &	GetChans ()

void	SignalHandler (int signal)

void	Exit (int status)

void	Rehash (const std::string &uuid="")

bool	PassCompare (Extensible *ex, const std::string &data, const std::string &input, const std::string &hashtype)

std::string	GetVersionString (bool getFullVersion=false)

void	WritePID (const std::string &filename, bool exitonfail=true)

	InspIRCd (int argc, char **argv)

void	Cleanup ()

void	Run ()

char *	GetReadBuffer ()

ClientProtocol::RFCEvents &	GetRFCEvents ()

Static Public Member Functions
static void	DefaultGenRandom (char *output, size_t max)

static bool	DefaultIsChannel (const std::string &channel)

static bool	IsHost (const std::string &host)

static bool	IsSID (const std::string &sid)

static void	SetSignal (int signal)

static std::string	Format (const char *formatString,...)

static std::string	Format (va_list &vaList, const char *formatString)

static bool	DefaultIsNick (const std::string &nick)

static bool	DefaultIsIdent (const std::string &ident)

static bool	Match (const std::string &str, const std::string &mask, unsigned const char *map=NULL)

static bool	Match (const char str, const char mask, unsigned const char *map=NULL)

static bool	MatchCIDR (const std::string &str, const std::string &mask, unsigned const char *map=NULL)

static bool	MatchCIDR (const char str, const char mask, unsigned const char *map=NULL)

static bool	MatchMask (const std::string &masks, const std::string &hostname, const std::string &ipaddr)

static bool	IsValidMask (const std::string &mask)

static void	StripColor (std::string &sentence)

static void	ProcessColors (file_cache &input)

static unsigned long	Duration (const std::string &str)

static bool	Duration (const std::string &str, unsigned long &duration)

static bool	IsValidDuration (const std::string &str)

static std::string	DurationString (time_t duration)

static std::string	TimeString (time_t curtime, const char *format=NULL, bool utc=false)

static bool	TimingSafeCompare (const std::string &one, const std::string &two)

Public Attributes
UIDGenerator	UIDGen

CullList	GlobalCulls

ActionList	AtomicActions

FakeUser *	FakeClient

time_t	startup_time

std::string	ConfigFileName

ExtensionManager	Extensions

ModeParser	Modes

CommandParser	Parser

ThreadEngine	Threads

ConfigReaderThread *	ConfigThread

LogManager	Logs

ModuleManager	Modules

BanCacheManager	BanCache

serverstats	stats

ServerConfig *	Config

SnomaskManager	SNO

TimerManager	Timers

XLineManager *	XLines

UserManager	Users

chan_hash	chanlist

std::vector< ListenSocket * >	ports

ProtocolInterface *	PI

ProtocolInterface	DefaultProtocolInterface

ISupportManager	ISupport

std::tr1 ::function< void(char *, size_t)>	GenRandom

std::tr1 ::function< bool(const std::string &)>	IsChannel

std::tr1 ::function< bool(const std::string &)>	IsNick

std::tr1 ::function< bool(const std::string &)>	IsIdent

Static Public Attributes
static sig_atomic_t	s_signal = 0

Detailed Description

The main class of the irc server. This class contains instances of all the other classes in this software. Amongst other things, it contains a ModeParser, a DNS object, a CommandParser object, and a list of active Module objects, and facilities for Module objects to interact with the core system it implements.

Constructor & Destructor Documentation

◆ InspIRCd()

InspIRCd::InspIRCd	(	int	argc,
		char **	argv
	)

This constructor initialises all the subsystems and reads the config file.

Parameters

argc	The argument count passed to main()
argv	The argument list passed to main()

Exceptions

<anything> If anything is thrown from here and makes it to you, you should probably just give up and go home. Yes, really. It's that bad. Higher level classes should catch any non-fatal exceptions.

Member Function Documentation

◆ BindPort()

bool InspIRCd::BindPort	(	ConfigTag *	tag,
		const irc::sockets::sockaddrs &	sa,
		std::vector< ListenSocket * > &	old_ports
	)

Bind to a specific port from a config tag.

Parameters

tag	the tag that contains bind information.
sa	The endpoint to listen on.
old_ports	Previously listening ports that may be on the same endpoint.

◆ BindPorts()

size_t InspIRCd::BindPorts ( FailedPortList & failed_ports )

Bind all ports specified in the configuration file.

Returns: The number of ports bound without error

◆ Cleanup()

void InspIRCd::Cleanup ( )

Prepare the ircd for restart or shutdown. This function unloads all modules which can be unloaded, closes all open sockets, and closes the logfile.

◆ DefaultGenRandom()

void InspIRCd::DefaultGenRandom	(	char *	output,
		size_t	max
	)

static

Fills the output buffer with the specified number of random characters. This is the default function for InspIRCd::GenRandom.

Parameters

output	The output buffer to store random characters in.
max	The maximum number of random characters to put in the buffer.

◆ DefaultIsChannel()

bool InspIRCd::DefaultIsChannel ( const std::string & channel )

static

Determines whether a channel name is valid according to the RFC 1459 rules. This is the default function for InspIRCd::IsChannel.

Parameters

channel The channel name to validate.

Returns: True if the channel name is valid according to RFC 1459 rules; otherwise, false.

◆ DefaultIsIdent()

bool InspIRCd::DefaultIsIdent ( const std::string & ident )

static

Determines whether a ident is valid according to the RFC 1459 rules. This is the default function for InspIRCd::IsIdent.

Parameters

ident The ident to validate.

Returns: True if the ident is valid according to RFC 1459 rules; otherwise, false.

◆ DefaultIsNick()

bool InspIRCd::DefaultIsNick ( const std::string & nick )

static

Determines whether a nickname is valid according to the RFC 1459 rules. This is the default function for InspIRCd::IsNick.

Parameters

nick	The nickname to validate.

Returns: True if the nickname is valid according to RFC 1459 rules; otherwise, false.

◆ Duration() [1/2]

unsigned long InspIRCd::Duration ( const std::string & str )

static

Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s

Parameters

str	A string containing a time in the form 1y2w3d4h6m5s (one year, two weeks, three days, four hours, six minutes and five seconds)

Returns: The total number of seconds

◆ Duration() [2/2]

bool InspIRCd::Duration	(	const std::string &	str,
		unsigned long &	duration
	)

static

Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s

Parameters

str	A string containing a time in the form 1y2w3d4h6m5s (one year, two weeks, three days, four hours, six minutes and five seconds)
duration	The location to place the parsed duration valur

Returns: Whether the duration was a valid format or not

◆ DurationString()

std::string InspIRCd::DurationString ( time_t duration )

static

Return a duration in seconds as a human-readable string.

Parameters

duration The duration in seconds to convert to a human-readable string.

Returns: A string representing the given duration.

◆ Exit()

void InspIRCd::Exit ( int status )

Causes the server to exit after unloading modules and closing all open file descriptors.

Parameters

status The exit code to give to the operating system (See the ExitStatus enum for valid values)

◆ FindChan()

Channel * InspIRCd::FindChan ( const std::string & chan )

Find a channel in the channels hash

Parameters

chan	The channel to find

Returns: A pointer to the channel, or NULL if the channel does not exist

◆ FindNick()

User * InspIRCd::FindNick ( const std::string & nick )

Find a user in the nick hash. If the user cant be found in the nick hash check the uuid hash

Parameters

nick	The nickname to find

Returns: A pointer to the user, or NULL if the user does not exist

◆ FindNickOnly()

User * InspIRCd::FindNickOnly ( const std::string & nick )

Find a user in the nick hash ONLY

◆ FindUUID()

User * InspIRCd::FindUUID ( const std::string & uid )

Find a user in the UUID hash

Parameters

uid	The UUID to find

Returns: A pointer to the user, or NULL if the user does not exist

◆ Format()

std::string InspIRCd::Format	(	const char *	formatString,
			...
	)

static

Formats the input string with the specified arguments.

Parameters

formatString	The string to format
...	A variable number of format arguments.

Returns: The formatted string

◆ GenRandomInt()

unsigned long InspIRCd::GenRandomInt ( unsigned long max )

Generate a random integer. This is generally more secure than rand()

◆ GenRandomStr()

std::string InspIRCd::GenRandomStr	(	unsigned int	length,
		bool	printable = `true`
	)

Generate a random string with the given length

Parameters

length	The length in bytes
printable	if false, the string will use characters 0-255; otherwise, it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)

◆ GetChans()

chan_hash& InspIRCd::GetChans ( )

inline

Get a hash map containing all channels, keyed by their name

Returns: A hash map mapping channel names to Channel pointers

◆ GetVersionString()

std::string InspIRCd::GetVersionString ( bool getFullVersion = false )

Returns the full version string of this ircd

Returns: The version string

◆ IsHost()

bool InspIRCd::IsHost ( const std::string & host )

static

Determines whether a hostname is valid according to RFC 5891 rules.

Parameters

host	The hostname to validate.

Returns: True if the hostname is valid; otherwise, false.

◆ IsSID()

bool InspIRCd::IsSID ( const std::string & sid )

static

Return true if str looks like a server ID

Parameters

sid	string to check against

◆ IsValidDuration()

bool InspIRCd::IsValidDuration ( const std::string & str )

static

Determines whether a string contains a valid duration.

Parameters

str	A string containing a time in the form 1y2w3d4h6m5s

Returns: True if the string is a valid duration; otherwise, false.

◆ IsValidMask()

bool InspIRCd::IsValidMask ( const std::string & mask )

static

Return true if the given parameter is a valid [email protected] mask

Parameters

mask	A [email protected] masak to match against

Returns: True i the mask is valid

◆ Match()

bool InspIRCd::Match	(	const std::string &	str,
		const std::string &	mask,
		unsigned const char *	map = `NULL`
	)

static

Match two strings using pattern matching, optionally, with a map to check case against (may be NULL). If map is null, match will be case insensitive.

Parameters

str	The literal string to match against
mask	The glob pattern to match against.
map	The character map to use when matching.

◆ MatchCIDR()

bool InspIRCd::MatchCIDR	(	const std::string &	str,
		const std::string &	mask,
		unsigned const char *	map = `NULL`
	)

static

Match two strings using pattern matching, optionally, with a map to check case against (may be NULL). If map is null, match will be case insensitive. Supports CIDR patterns as well as globs.

Parameters

str	The literal string to match against
mask	The glob or CIDR pattern to match against.
map	The character map to use when matching.

◆ MatchMask()

bool InspIRCd::MatchMask	(	const std::string &	masks,
		const std::string &	hostname,
		const std::string &	ipaddr
	)

static

Matches a hostname and IP against a space delimited list of hostmasks.

Parameters

masks	The space delimited masks to match against.
hostname	The hostname to try and match.
ipaddr	The IP address to try and match.

◆ PassCompare()

bool InspIRCd::PassCompare	(	Extensible *	ex,
		const std::string &	data,
		const std::string &	input,
		const std::string &	hashtype
	)

Attempt to compare a password to a string from the config file. This will be passed to handling modules which will compare the data against possible hashed equivalents in the input string.

Parameters

ex	The object (user, server, whatever) causing the comparison.
data	The data from the config file
input	The data input by the oper
hashtype	The hash from the config file

Returns: True if the strings match, false if they do not

◆ ProcessColors()

void InspIRCd::ProcessColors ( file_cache & input )

static

Parses color codes from string values to actual color codes

Parameters

input The data to process

◆ Rehash()

void InspIRCd::Rehash ( const std::string & uuid = "" )

Rehash the local server

Parameters

uuid	The uuid of the user who started the rehash, can be empty

◆ Run()

void InspIRCd::Run ( )

Begin execution of the server. NOTE: this function NEVER returns. Internally, it will repeatedly loop.

◆ SetSignal()

void InspIRCd::SetSignal ( int signal )

static

Sets the signal received

Parameters

signal the signal received

◆ SignalHandler()

void InspIRCd::SignalHandler ( int signal )

Handles incoming signals after being set

Parameters

signal the signal received

◆ StripColor()

void InspIRCd::StripColor ( std::string & sentence )

static

Strips all color and control codes except 001 from the given string

Parameters

sentence The string to strip from

◆ Time()

time_t InspIRCd::Time ( )

inline

Get the current time Because this only calls time() once every time around the mainloop, it is much faster than calling time() directly.

Returns: The current time as an epoch value (time_t)

◆ Time_ns()

long InspIRCd::Time_ns ( )

inline

The fractional time at the start of this mainloop iteration (nanoseconds)

◆ TimeString()

std::string InspIRCd::TimeString	(	time_t	curtime,
		const char *	format = `NULL`,
		bool	utc = `false`
	)

static

Return a time_t as a human-readable string.

Parameters

format	The format to retrieve the date/time in. See `man 3 strftime` for more information. If NULL, "%a %b %d %T %Y" is assumed.
curtime	The timestamp to convert to a human-readable string.
utc	True to convert the time to string as-is, false to convert it to local time first.

Returns: A string representing the given date/time.

◆ TimingSafeCompare()

bool InspIRCd::TimingSafeCompare	(	const std::string &	one,
		const std::string &	two
	)

static

Compare two strings in a timing-safe way. If the lengths of the strings differ, the function returns false immediately (leaking information about the length), otherwise it compares each character and only returns after all characters have been compared.

Parameters

one	First string
two	Second string

Returns: True if the strings match, false if they don't

◆ UpdateTime()

void InspIRCd::UpdateTime ( )

Update the current time. Don't call this unless you have reason to do so.

◆ WritePID()

void InspIRCd::WritePID	(	const std::string &	filename,
		bool	exitonfail = `true`
	)

Attempt to write the process id to a given file

Parameters

filename	The PID file to attempt to write to
exitonfail	If true and the PID fail cannot be written log to stdout and exit, otherwise only log on failure

Returns: This function may bail if the file cannot be written

Member Data Documentation

◆ AtomicActions

ActionList InspIRCd::AtomicActions

Actions that must happen outside of the current call stack

◆ BanCache

BanCacheManager InspIRCd::BanCache

BanCacheManager is used to speed up checking of restrictions on connection to the IRCd.

◆ chanlist

chan_hash InspIRCd::chanlist

Channel list, a hash_map containing all channels XXX move to channel manager class

◆ Config

ServerConfig* InspIRCd::Config

Server Config class, holds configuration file data

◆ ConfigFileName

std::string InspIRCd::ConfigFileName

Config file pathname specified on the commandline or via ./configure

◆ ConfigThread

ConfigReaderThread* InspIRCd::ConfigThread

The thread/class used to read config files in REHASH and on startup

◆ DefaultProtocolInterface

ProtocolInterface InspIRCd::DefaultProtocolInterface

Default implementation of the ProtocolInterface, does nothing

◆ FakeClient

FakeUser* InspIRCd::FakeClient

Globally accessible fake user record. This is used to force mode changes etc across s2s, etc.. bit ugly, but.. better than how this was done in 1.1 Reason for it: kludge alert! SendMode expects a User* to send the numeric replies back to, so we create it a fake user that isn't in the user hash and set its descriptor to FD_MAGIC_NUMBER so the data falls into the abyss :p

◆ GenRandom

std::tr1 ::function<void(char*, size_t)> InspIRCd::GenRandom

Fill a buffer with random bits

◆ GlobalCulls

CullList InspIRCd::GlobalCulls

Global cull list, will be processed on next iteration

◆ IsChannel

std::tr1 ::function<bool(const std::string&)> InspIRCd::IsChannel

Determines whether an channel name is valid.

◆ IsIdent

std::tr1 ::function<bool(const std::string&)> InspIRCd::IsIdent

Determines whether an ident is valid.

◆ IsNick

std::tr1 ::function<bool(const std::string&)> InspIRCd::IsNick

Determines whether a nickname is valid.

◆ ISupport

ISupportManager InspIRCd::ISupport

Manages the generation and transmission of ISUPPORT.

◆ Logs

LogManager InspIRCd::Logs

LogManager handles logging.

◆ Modes

ModeParser InspIRCd::Modes

Mode handler, handles mode setting and removal

◆ Modules

ModuleManager InspIRCd::Modules

ModuleManager contains everything related to loading/unloading modules.

◆ Parser

CommandParser InspIRCd::Parser

Command parser, handles client to server commands

◆ PI

ProtocolInterface* InspIRCd::PI

Protocol interface, overridden by server protocol modules

◆ ports

std::vector<ListenSocket*> InspIRCd::ports

List of the open ports

◆ s_signal

sig_atomic_t InspIRCd::s_signal = 0

static

Set to the current signal received

◆ SNO

SnomaskManager InspIRCd::SNO

Snomask manager - handles routing of snomask messages to opers.

◆ startup_time

time_t InspIRCd::startup_time

Time this ircd was booted

◆ stats

serverstats InspIRCd::stats

Stats class, holds miscellaneous stats counters

◆ Threads

ThreadEngine InspIRCd::Threads

Thread engine, Handles threading where required

◆ Timers

TimerManager InspIRCd::Timers

Timer manager class, triggers Timer timer events

◆ Users

UserManager InspIRCd::Users

User manager. Various methods and data associated with users.

◆ XLines

XLineManager* InspIRCd::XLines

X-line manager. Handles G/K/Q/E-line setting, removal and matching

The documentation for this class was generated from the following files:

include/inspircd.h
src/command_parse.cpp
src/helperfuncs.cpp
src/inspircd.cpp
src/inspstring.cpp
src/server.cpp
src/socket.cpp
src/wildcard.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ InspIRCd()

Member Function Documentation

◆ BindPort()

◆ BindPorts()

◆ Cleanup()

◆ DefaultGenRandom()

◆ DefaultIsChannel()

◆ DefaultIsIdent()

◆ DefaultIsNick()

◆ Duration() [1/2]

◆ Duration() [2/2]

◆ DurationString()

◆ Exit()

◆ FindChan()

◆ FindNick()

◆ FindNickOnly()

◆ FindUUID()

◆ Format()

◆ GenRandomInt()

◆ GenRandomStr()

◆ GetChans()

◆ GetVersionString()

◆ IsHost()

◆ IsSID()

◆ IsValidDuration()

◆ IsValidMask()

◆ Match()

◆ MatchCIDR()

◆ MatchMask()

◆ PassCompare()

◆ ProcessColors()

◆ Rehash()

◆ Run()

◆ SetSignal()

◆ SignalHandler()

◆ StripColor()

◆ Time()

◆ Time_ns()

◆ TimeString()

◆ TimingSafeCompare()

◆ UpdateTime()

◆ WritePID()

Member Data Documentation

◆ AtomicActions

◆ BanCache

◆ chanlist

◆ Config

◆ ConfigFileName

◆ ConfigThread

◆ DefaultProtocolInterface

◆ FakeClient

◆ GenRandom

◆ GlobalCulls

◆ IsChannel

◆ IsIdent

◆ IsNick

◆ ISupport

◆ Logs

◆ Modes

◆ Modules

◆ Parser

◆ PI

◆ ports

◆ s_signal

◆ SNO

◆ startup_time

◆ stats

◆ Threads

◆ Timers

◆ Users

◆ XLines