1

#ifndef IRC_PROTO_H

     2

#define IRC_PROTO_H

     3

     4

/**

     5

 * @file

     6

 *

     7

 * General IRC protocol things, such as prefix/nickmask/nickname parsing

     8

 */

     9

#include "error.h"

    10

#include <stddef.h>

    11

    12

/**

    13

 * Default TCP port for normal connections

    14

 */

    15

#define IRC_PORT "6667"

    16

    17

/**

    18

 * Default TCP port for SSL connections

    19

 */

    20

#define IRC_SSL_PORT "6697"

    21

    22

/**

    23

 * Maximum length of an IRC nickname including terminating NUL.

    24

 */

    25

#define IRC_NICK_MAX (30 + 1)

    26

    27

/**

    28

 * Maximum length of an IRC prefix/nickmask string, including any termianting NULs.

    29

 *

    30

 * XXX: currently this is pretty large, but does it really matter? We have more than 4k stack...

    31

 */

    32

#define IRC_PREFIX_MAX 510

    33

    34

/**

    35

 * Maximum length of an IRC nickname channel flags prefix, including any terminating NUL

    36

 */

    37

#define IRC_CHANFLAGS_MAX (8 + 1)

    38

    39

/**

    40

 * The set of characters that are considered nickname channel flag prefixes (i.e. op, voice, etc).

    41

 *

    42

 * XXX: many IRCd's have more than these, should use the 005 reply instead.

    43

 */

    44

#define IRC_CHANFLAGS "@+"

    45

    46

/**

    47

 * Parsed nickmask. For normal user prefixes, all fields will be non-NULL. For server prefixes, nickname and username

    48

 * will be NULL, and hostname will be the server name.

    49

 */

    50

struct irc_nm {

    51

    /** Nickname, not normalized */

    52

    const char *nickname;

    53

    54

    /** Username, including any ident-related prefix from the network */

    55

    const char *username;

    56

    57

    /** Hostname, either reverse DNS hostname, literal IPv4, literal IPv6, or something else... */

    58

    const char *hostname;

    59

};

    60

    61

/**

    62

 * Parse a full nickmask from a prefix, mutating the value of the given buffer, and returning pointers into the buffer

    63

 * inside \a nm.

    64

 */

    65

err_t irc_nm_parse_buf (struct irc_nm *nm, char *prefix);

    66

    67

/**

    68

 * Same as irc_nm_parse_buf(), but copies the prefix into the given mutable buffer of at least IRC_PREFIX_MAX bytes and

    69

 * returns pointers into that instead.

    70

 */

    71

err_t irc_nm_parse (struct irc_nm *nm, char *buf, const char *prefix);

    72

    73

/**

    74

 * Compare two nicknames for equality, with standard cmp() semantics.

    75

 */

    76

int irc_cmp_nick (const char *nick1, const char *nick2);

    77

    78

/**

    79

 * Compare up to the first n chars of the two nickname strings for equality, with standard cmp() semantics.

    80

 */

    81

int irc_ncmp_nick (const char *nick1, const char *nick2, size_t n);

    82

    83

/**

    84

 * Parse the nickname portion of a prefix, storing it in the given buffer of IRC_NICK_MAX bytes.

    85

 */

    86

err_t irc_prefix_parse_nick (const char *prefix, char nick[IRC_NICK_MAX]);

    87

    88

/**

    89

 * Compare the nickname in the given prefix and with the given nickname for equality.

    90

 *

    91

 * @return -err for invalid prefix, 0 for match, >0 for non-match.

    92

 */

    93

int irc_prefix_cmp_nick (const char *prefix, const char *nick);

    94

    95

/**

    96

 * Copy the prefixed flags from the given nickname into the given flags buffer (of at least IRC_CHANFLAGS_MAX bytes) and

    97

 * NUL-terminate it. Returns a pointer to the actual nickname itself.

    98

 *

    99

 * @param nickname the nickname including prefixed chanflags

   100

 * @param chanflags buffer to store the parsed chanflags into

   101

 * @return a pointer to the first char of the actual nickname

   102

 */

   103

const char* irc_nick_chanflags (const char *nickname, char chanflags[IRC_CHANFLAGS_MAX]);

   104

   105

/**

   106

 * @defgroup IRC_RPL_ IRC command numerics

   107

 * @{

   108

 */

   109

   110

/**

   111

 * 001 <nick> "Welcome to the Internet Relay Network <nick>!<user>@<host>"

   112

 *

   113

 * The first "official" reply sent by the server after the NICK/USER registration was accepted.

   114

 */

   115

#define IRC_RPL_WELCOME         "001"

   116

   117

/**

   118

 * 353 <nick> ( "=" | "*" | "@" ) <channel> ( [ "@" | "+" ] <nick> [ " " ... ] )

   119

 *

   120

 * Sent by the server after a JOIN/NAMES command to give the full list of users currently on a channel. The list may

   121

 * be split into multiple messages RPL_NAMREPLY messages, which are then terminated by a RPL_ENDOFNAMES reply.

   122

 *

   123

 * The first argument char denotes the "channel type", and is, apparently, one of the following, for those who care:

   124

 *  @   secret

   125

 *  *   private

   126

 *  =   others (public)

   127

 */

   128

#define IRC_RPL_NAMREPLY        "353"

   129

   130

/**

   131

 * 366 <nick> <channel> "End of NAMES list"

   132

 *

   133

 * Sent by the server to terminate a sequence of zero or more RPL_NAMREPLY messages from a JOIN/NAMES command.

   134

 */

   135

#define IRC_RPL_ENDOFNAMES      "366"

   136

   137

// @}

   138

   139

#endif