Cinch

Constants

Returned by the server to any link which tries to change part of the registered details (such as password or user details from second USER message).

ERR_BADCHANNELKEY

ERR_BANNEDFROMCHAN

ERR_CANNOTSENDTOCHAN

Sent to a user who is either

- not on a channel which is mode +n
- not a chanop (or mode +v) on a channel which has mode +m set
  and is trying to send a PRIVMSG message to that channel.

ERR_CANTKILLSERVER

Any attempts to use the KILL command on a server are to be refused and this error returned directly to the client.

ERR_CHANNELISFULL

ERR_CHANOPRIVSNEEDED

Any command requiring 'chanop' privileges (such as MODE messages) must return this error if the client making the attempt is not a chanop on the specified channel.

ERR_ERRONEUSNICKNAME

Returned after receiving a NICK message which contains characters which do not fall in the defined set.

ERR_FILEERROR

Generic error message used to report a failed file operation during the processing of a message.

ERR_INVITEONLYCHAN

ERR_KEYSET

ERR_NEEDMOREPARAMS

Returned by the server by numerous commands to indicate to the client that it didn't supply enough parameters.

ERR_NICKCOLLISION

Returned by a server to a client when it detects a nickname collision (registered of a NICK that already exists by another server).

ERR_NICKNAMEINUSE

Returned when a NICK message is processed that results in an attempt to change to a currently existing nickname.

ERR_NOADMININFO

Returned by a server in response to an ADMIN message when there is an error in finding the appropriate information.

ERR_NOLOGIN

Returned by the summon after a SUMMON command for a user was unable to be performed since they were not logged in.

ERR_NOMOTD

Server's MOTD file could not be opened by the server.

ERR_NONICKNAMEGIVEN

Returned when a nickname parameter expected for a command and isn't found.

ERR_NOOPERHOST

If a client sends an OPER message and the server has not been configured to allow connections from the client's host as an operator, this error must be returned.

ERR_NOORIGIN

PING or PONG message missing the originator parameter which is required since these commands must work without valid prefixes.

ERR_NOPERMFORHOST

Returned to a client which attempts to register with a server which does not been setup to allow connections from the host the attempted connection is tried.

ERR_NOPRIVILEGES

Any command requiring operator privileges to operate must return this error to indicate the attempt was unsuccessful.

ERR_NORECIPIENT

ERR_NOSUCHCHANNEL

Used to indicate the given channel name is invalid.

ERR_NOSUCHNICK

Used to indicate the nickname parameter supplied to a command is currently unused.

ERR_NOSUCHSERVER

Used to indicate the server name given currently doesn't exist.

ERR_NOTEXTTOSEND

ERR_NOTONCHANNEL

Returned by the server whenever a client tries to perform a channel effecting command for which the client isn't a member.

ERR_NOTOPLEVEL

ERR_NOTREGISTERED

Returned by the server to indicate that the client must be registered before the server will allow it to be parsed in detail.

ERR_PASSWDMISMATCH

Returned to indicate a failed attempt at registering a connection for which a password was required and was either not given or incorrect.

ERR_SUMMONDISABLED

Returned as a response to the SUMMON command. Must be returned by any server which does not implement it.

ERR_TOOMANYCHANNELS

Sent to a user when they have joined the maximum number of allowed channels and they try to join another channel.

ERR_TOOMANYTARGETS

Returned to a client which is attempting to send PRIVMSG/NOTICE using the user@host destination format and for a user@host which has several occurrences.

ERR_UMODEUNKNOWNFLAG

Returned by the server to indicate that a MODE message was sent with a nickname parameter and that the a mode flag sent was not recognized.

ERR_UNKNOWNCOMMAND

Returned to a registered client to indicate that the command sent is unknown by the server.

ERR_UNKNOWNMODE

ERR_USERNOTINCHANNEL

Returned by the server to indicate that the target user of the command is not on the given channel.

ERR_USERONCHANNEL

Returned when a client tries to invite a user to a channel they are already on.

ERR_USERSDISABLED

Returned as a response to the USERS command. Must be returned by any server which does not implement it.

ERR_USERSDONTMATCH

Error sent to any user trying to view or change the user mode for a user other than themselves.

ERR_WASNOSUCHNICK

Returned by WHOWAS to indicate there is no history information for that nickname.

ERR_WILDTOPLEVEL

412 - 414 are returned by PRIVMSG to indicate that the message wasn't delivered for some reason. ERR_NOTOPLEVEL and ERR_WILDTOPLEVEL are errors that are returned when an invalid use of "PRIVMSG $<server>" or "PRIVMSG #<host>" is attempted.

ERR_YOUREBANNEDCREEP

Returned after an attempt to connect and register yourself with a server which has been setup to explicitly deny connections to you.

RPL_ADMINEMAIL

When replying to an ADMIN message, a server is expected to use replies RLP_ADMINME through to RPL_ADMINEMAIL and provide a text message with each. For RPL_ADMINLOC1 a description of what city, state and country the server is in is expected, followed by details of the university and department (RPL_ADMINLOC2) and finally the administrative contact for the server (an email address here is required) in RPL_ADMINEMAIL.

RPL_AWAY is sent to any client sending a PRIVMSG to a client which is away. RPL_AWAY is only sent by the server to which the client is connected.

RPL_BANLIST

RPL_CHANNELMODEIS

RPL_ENDOFBANLIST

When listing the active 'bans' for a given channel, a server is required to send the list back using the RPL_BANLIST and RPL_ENDOFBANLIST messages. A separate RPL_BANLIST is sent for each active banid. After the banids have been listed (or if none present) a RPL_ENDOFBANLIST must be sent.

RPL_ENDOFINFO

A server responding to an INFO message is required to send all its 'info' in a series of RPL_INFO messages with a RPL_ENDOFINFO reply to indicate the end of the replies.

RPL_ENDOFLINKS

In replying to the LINKS message, a server must send replies back using the RPL_LINKS numeric and mark the end of the list using an RPL_ENDOFLINKS reply.

RPL_ENDOFMOTD

When responding to the MOTD message and the MOTD file is found, the file is displayed line by line, with each line no longer than 80 characters, using RPL_MOTD format replies. These should be surrounded by a RPL_MOTDSTART (before the RPL_MOTDs) and an RPL_ENDOFMOTD (after).

RPL_ENDOFNAMES

To reply to a NAMES message, a reply pair consisting of RPL_NAMREPLY and RPL_ENDOFNAMES is sent by the server back to the client. If there is no channel found as in the query, then only RPL_ENDOFNAMES is returned. The exception to this is when a NAMES message is sent with no parameters and all visible channels and contents are sent back in a series of RPL_NAMEREPLY messages with a RPL_ENDOFNAMES to mark the end.

RPL_ENDOFSTATS

RPL_ENDOFUSERS

RPL_ENDOFWHO

The RPL_WHOREPLY and RPL_ENDOFWHO pair are used to answer a WHO message. The RPL_WHOREPLY is only sent if there is an appropriate match to the WHO query. If there is a list of parameters supplied with a WHO message, a RPL_ENDOFWHO must be sent after processing each list item with <name> being the item.

RPL_ENDOFWHOIS

RPL_ENDOFWHOWAS

When replying to a WHOWAS message, a server must use the replies RPL_WHOWASUSER, RPL_WHOISSERVER or ERR_WASNOSUCHNICK for each nickname in the presented list. At the end of all reply batches, there must be RPL_ENDOFWHOWAS (even if there was only one reply and it was an error).

RPL_INFO

RPL_INVITING

Returned by the server to indicate that the attempted INVITE message was successful and is being passed onto the end client.

RPL_ISON

Reply format used by ISON to list replies to the query list.

RPL_LINKS

RPL_LIST

RPL_LISTEND

Replies RPL_LISTSTART, RPL_LIST, RPL_LISTEND mark the start, actual replies with data and end of the server's response to a LIST command. If there are no channels available to return, only the start and end reply must be sent.

RPL_LISTSTART

RPL_LUSERCHANNELS

RPL_LUSERCLIENT

RPL_LUSERME

In processing an LUSERS message, the server sends a set of replies from RPL_LUSERCLIENT, RPL_LUSEROP, RPL_USERUNKNOWN, RPL_LUSERCHANNELS and RPL_LUSERME. When replying, a server must send back RPL_LUSERCLIENT and RPL_LUSERME. The other replies are only sent back if a non-zero count is found for them.

If the USERS message is handled by a server, the replies RPL_USERSTART, RPL_USERS, RPL_ENDOFUSERS and RPL_NOUSERS are used. RPL_USERSSTART must be sent first, following by either a sequence of RPL_USERS or a single RPL_NOUSER. Following this is RPL_ENDOFUSERS.

RPL_NOWAWAY

Replies RPL_UNAWAY and RPL_NOWAWAY are sent when the client removes and sets an AWAY message

RPL_REHASHING

If the REHASH option is used and an operator sends a REHASH message, an RPL_REHASHING is sent back to the operator.

RPL_STATSCLINE

RPL_STATSCOMMANDS

RPL_STATSHLINE

RPL_STATSILINE

RPL_STATSKLINE

RPL_STATSLINKINFO

Returned by a server answering a SUMMON message to indicate that it is summoning that user.

RPL_TIME

When replying to the TIME message, a server must send the reply using the RPL_TIME format above. The string showing the time need only contain the correct day and time there. There is no further requirement for the time string.

RPL_TOPIC

When sending a TOPIC message to determine the channel topic, one of two replies is sent. If the topic is set, RPL_TOPIC is sent back else RPL_NOTOPIC.

RPL_TRACECONNECTING

RPL_TRACEHANDSHAKE

RPL_TRACELINK

RPL_TRACELOG

The RPL_TRACE* are all returned by the server in response to the TRACE message. How many are returned is dependent on the the TRACE message and whether it was sent by an operator or not. There is no predefined order for which occurs first. Replies RPL_TRACEUNKNOWN, RPL_TRACECONNECTING and RPL_TRACEHANDSHAKE are all used for connections which have not been fully established and are either unknown, still attempting to connect or in the process of completing the 'server handshake'. RPL_TRACELINK is sent by any server which handles a TRACE message and has to pass it on to another server. The list of RPL_TRACELINKs sent in response to a TRACE command traversing the IRC network should reflect the actual connectivity of the servers themselves along that path. RPL_TRACENEWTYPE is to be used for any connection which does not fit in the other categories but is being displayed anyway.

RPL_TRACENEWTYPE

RPL_TRACEOPERATOR

To answer a query about a client's own mode, RPL_UMODEIS is sent back.

RPL_UNAWAY

Replies RPL_UNAWAY and RPL_NOWAWAY are sent when the client removes and sets an AWAY message

RPL_USERHOST

Reply format used by USERHOST to list replies to the query list.

RPL_USERS

RPL_USERSSTART

RPL_VERSION

Reply by the server showing its version details. The &lt;version&gt;
is the version of the software being used (including any patchlevel
revisions) and the &lt;debuglevel&gt; is used to indicate if the
server is running in "debug mode".

The "comments" field may contain any comments about the version or

further version details.

RPL_WHOISCHANNELS

Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message. Given that there are enough parameters present, the answering server must either formulate a reply out of the above numerics (if the query nick is found) or return an error reply. The '*' in RPL_WHOISUSER is there as the literal character and not as a wild card. For each reply set, only RPL_WHOISCHANNELS may appear more than once (for long lists of channel names). The '@' and '+' characters next to the channel name indicate whether a client is a channel operator or has been granted permission to speak on a moderated channel. The RPL_ENDOFWHOIS reply is used to mark the end of processing a WHOIS message.

RPL_WHOISIDLE

RPL_WHOISOPERATOR

RPL_YOUREOPER is sent back to a client which has just successfully issued an OPER message and gained operator status.

VERSION

Public Class Methods

encode_incoming(string, encoding) click to toggle source

@api private

# File lib/cinch.rb, line 14
def self.encode_incoming(string, encoding)
  string = string.dup
  if encoding == :irc
    # If incoming text is valid UTF-8, it will be interpreted as
    # such. If it fails validation, a CP1252 -&gt; UTF-8 conversion
    # is performed. This allows you to see non-ASCII from mIRC
    # users (non-UTF-8) and other users sending you UTF-8.
    #
    # (from http://xchat.org/encoding/#hybrid)
    string.force_encoding("UTF-8")
    if !string.valid_encoding?
      string.force_encoding("CP1252").encode!("UTF-8", {:invalid => :replace, :undef => :replace})
    end
  else
    string.force_encoding(encoding).encode!({:invalid => :replace, :undef => :replace})
    string = string.chars.select { |c| c.valid_encoding? }.join
  end

  return string
end

encode_outgoing(string, encoding) click to toggle source

@api private

# File lib/cinch.rb, line 36
def self.encode_outgoing(string, encoding)
  string = string.dup
  if encoding == :irc
    # If your text contains only characters that fit inside the CP1252
    # code page (aka Windows Latin-1), the entire line will be sent
    # that way. mIRC users should see it correctly. XChat users who
    # are using UTF-8 will also see it correctly, because it will fail
    # UTF-8 validation and will be assumed to be CP1252, even by older
    # XChat versions.
    #
    # If the text doesn't fit inside the CP1252 code page, (for eaxmple if you
    # type Eastern European characters, or Russian) it will be sent as UTF-8. Only
    # UTF-8 capable clients will be able to see these characters correctly
    #
    # (from http://xchat.org/encoding/#hybrid)
    begin
      string.encode!("CP1252")
    rescue Encoding::UndefinedConversionError
    end
  else
    string.encode!(encoding, {:invalid => :replace, :undef => :replace})
  end

  return string
end

filter_string(string) click to toggle source

@return [String] @todo Handle mIRC color codes more gracefully. @api private

# File lib/cinch.rb, line 9
def self.filter_string(string)
  string.gsub(/[\x00-\x1f]/, '')
end

Home Classes Methods

In Files

Namespace

Methods

Class/Module Index

Cinch

Constants

Public Class Methods