#include <ban.hpp>

Classes
struct	error

Public Member Functions
	banned (const std::string &ip, const utils::optional< std::chrono::system_clock::time_point > &end_time, const std::string &reason, const std::string &who_banned=who_banned_default_, const std::string &group="", const std::string &nick="")

	banned (const config &)

	banned (const std::string &ip)

void	read (const config &)

void	write (config &) const

const auto &	get_end_time () const

utils::optional< std::chrono::seconds >	get_remaining_ban_time () const
	Returns the seconds remaining until than ban expires, or nullopt if permanent. More...

std::string	get_human_end_time () const

std::string	get_human_start_time () const

std::string	get_reason () const

std::string	get_ip () const

std::string	get_group () const

std::string	get_who_banned () const

std::string	get_nick () const

bool	match_group (const std::string &group) const

bool	match_ip (const ip_mask &ip) const

bool	match_ipmask (const ip_mask &ip) const

unsigned int	get_mask_ip (unsigned int) const

unsigned int	get_int_ip () const

unsigned int	mask () const

bool	operator> (const banned &b) const

Private Attributes
unsigned int	ip_

unsigned int	mask_

std::string	ip_text_

utils::optional< std::chrono::system_clock::time_point >	end_time_

utils::optional< std::chrono::system_clock::time_point >	start_time_

std::string	reason_

std::string	who_banned_

std::string	group_

std::string	nick_

Static Private Attributes
static const std::string	who_banned_default_ = "system"

Detailed Description

Definition at line 60 of file ban.hpp.

Constructor & Destructor Documentation

◆ banned() [1/3]

wesnothd::banned::banned	(	const std::string &	ip,
		const utils::optional< std::chrono::system_clock::time_point > &	end_time,
		const std::string &	reason,
		const std::string &	who_banned = `who_banned_default_`,
		const std::string &	group = `""`,
		const std::string &	nick = `""`
	)

Definition at line 83 of file ban.cpp.

References ip_, ip_text_, mask_, and wesnothd::parse_ip().

◆ banned() [2/3]

wesnothd::banned::banned ( const config & cfg )

Definition at line 104 of file ban.cpp.

References read().

◆ banned() [3/3]

wesnothd::banned::banned ( const std::string & ip )

Definition at line 67 of file ban.cpp.

References ip_, mask_, and wesnothd::parse_ip().

Member Function Documentation

◆ get_end_time()

const auto& wesnothd::banned::get_end_time ( ) const

inline

Definition at line 87 of file ban.hpp.

References end_time_.

◆ get_group()

std::string wesnothd::banned::get_group ( ) const

inline

Definition at line 101 of file ban.hpp.

References group_.

◆ get_human_end_time()

std::string wesnothd::banned::get_human_end_time ( ) const

Definition at line 238 of file ban.cpp.

References end_time_, and chrono::format_local_timestamp().

◆ get_human_start_time()

std::string wesnothd::banned::get_human_start_time ( ) const

Definition at line 229 of file ban.cpp.

References chrono::format_local_timestamp(), and start_time_.

◆ get_int_ip()

unsigned int wesnothd::banned::get_int_ip ( ) const

inline

Definition at line 117 of file ban.hpp.

References ip_.

◆ get_ip()

std::string wesnothd::banned::get_ip ( ) const

inline

Definition at line 99 of file ban.hpp.

References ip_text_.

Referenced by write().

◆ get_mask_ip()

unsigned int wesnothd::banned::get_mask_ip ( unsigned int mask ) const

Definition at line 253 of file ban.cpp.

References ip_, mask(), and mask_.

◆ get_nick()

std::string wesnothd::banned::get_nick ( ) const

inline

Definition at line 107 of file ban.hpp.

References nick_.

Referenced by write().

◆ get_reason()

std::string wesnothd::banned::get_reason ( ) const

inline

Definition at line 96 of file ban.hpp.

References reason_.

◆ get_remaining_ban_time()

utils::optional< std::chrono::seconds > wesnothd::banned::get_remaining_ban_time ( ) const

Returns the seconds remaining until than ban expires, or nullopt if permanent.

Definition at line 219 of file ban.cpp.

References end_time_.

◆ get_who_banned()

std::string wesnothd::banned::get_who_banned ( ) const

inline

Definition at line 104 of file ban.hpp.

References who_banned_.

◆ mask()

unsigned int wesnothd::banned::mask ( ) const

inline

Definition at line 120 of file ban.hpp.

References mask_.

Referenced by get_mask_ip().

◆ match_group()

bool wesnothd::banned::match_group ( const std::string & group ) const

inline

Definition at line 110 of file ban.hpp.

References group_.

◆ match_ip()

bool wesnothd::banned::match_ip ( const ip_mask & ip ) const

Definition at line 258 of file ban.cpp.

References ip_, and mask_.

◆ match_ipmask()

bool wesnothd::banned::match_ipmask ( const ip_mask & ip ) const

Definition at line 264 of file ban.cpp.

References ip_, and mask_.

◆ operator>()

bool wesnothd::banned::operator> ( const banned & b ) const

Definition at line 247 of file ban.cpp.

References b, and end_time_.

◆ read()

void wesnothd::banned::read ( const config & cfg )

Definition at line 163 of file ban.cpp.

References end_time_, group_, config::has_attribute(), ip_, ip_text_, mask_, nick_, wesnothd::parse_ip(), chrono::parse_timestamp(), reason_, start_time_, and who_banned_.

Referenced by banned().

◆ write()

void wesnothd::banned::write ( config & cfg ) const

Definition at line 195 of file ban.cpp.

References end_time_, get_ip(), get_nick(), group_, reason_, chrono::serialize_timestamp(), start_time_, who_banned_, and who_banned_default_.

Member Data Documentation

◆ end_time_

utils::optional<std::chrono::system_clock::time_point> wesnothd::banned::end_time_

private

Definition at line 64 of file ban.hpp.

Referenced by get_end_time(), get_human_end_time(), get_remaining_ban_time(), operator>(), read(), and write().

◆ group_

std::string wesnothd::banned::group_

private

Definition at line 68 of file ban.hpp.

Referenced by get_group(), match_group(), read(), and write().

◆ ip_

unsigned int wesnothd::banned::ip_

private

Definition at line 61 of file ban.hpp.

Referenced by banned(), get_int_ip(), get_mask_ip(), match_ip(), match_ipmask(), and read().

◆ ip_text_

std::string wesnothd::banned::ip_text_

private

Definition at line 63 of file ban.hpp.

Referenced by banned(), get_ip(), and read().

◆ mask_

unsigned int wesnothd::banned::mask_

private

Definition at line 62 of file ban.hpp.

Referenced by banned(), get_mask_ip(), mask(), match_ip(), match_ipmask(), and read().

◆ nick_

std::string wesnothd::banned::nick_

private

Definition at line 69 of file ban.hpp.

Referenced by get_nick(), and read().

◆ reason_

std::string wesnothd::banned::reason_

private

Definition at line 66 of file ban.hpp.

Referenced by get_reason(), read(), and write().

◆ start_time_

utils::optional<std::chrono::system_clock::time_point> wesnothd::banned::start_time_

private

Definition at line 65 of file ban.hpp.

Referenced by get_human_start_time(), read(), and write().

◆ who_banned_

std::string wesnothd::banned::who_banned_

private

Definition at line 67 of file ban.hpp.

Referenced by get_who_banned(), read(), and write().

◆ who_banned_default_

const std::string wesnothd::banned::who_banned_default_ = "system"

staticprivate

Definition at line 70 of file ban.hpp.

Referenced by write().

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

server/wesnothd/ban.hpp
server/wesnothd/ban.cpp

Classes

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ banned() [1/3]

◆ banned() [2/3]

◆ banned() [3/3]

Member Function Documentation

◆ get_end_time()

◆ get_group()

◆ get_human_end_time()

◆ get_human_start_time()

◆ get_int_ip()

◆ get_ip()

◆ get_mask_ip()

◆ get_nick()

◆ get_reason()

◆ get_remaining_ban_time()

◆ get_who_banned()

◆ mask()

◆ match_group()

◆ match_ip()

◆ match_ipmask()

◆ operator>()

◆ read()

◆ write()

Member Data Documentation

◆ end_time_

◆ group_

◆ ip_

◆ ip_text_

◆ mask_

◆ nick_

◆ reason_

◆ start_time_

◆ who_banned_

◆ who_banned_default_