ircutils

Documentation

Overview

Package ircutils provides small, useful utility functions and classes.

This package is in an alpha stage.

Index

• Variables
• func HostnameIsValid(hostname string) bool
• func SanitizeText(message string, byteLimit int) (result string)

Variables

var TruncateUTF8Safe = ircmsg.TruncateUTF8Safe

Functions

func HostnameIsValid

func HostnameIsValid(hostname string) bool

HostnameIsValid provides a way for servers to check whether a looked-up client hostname is valid (see InspIRCd #1033 for why this is required).

This function shouldn't be called by clients since they don't need to validate hostnames for IRC use, just by servers that need to confirm hostnames of incoming clients.

In addition to this function, servers should impose their own limits on max hostname length -- this function limits it to 200 but most servers will probably want to make it smaller than that.

func SanitizeText

func SanitizeText(message string, byteLimit int) (result string)

Sanitizes human-readable text to make it safe for IRC; assumes UTF-8 and uses the replacement character where applicable.