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

 * Maximum length of an IRC nickname including terminating NUL.

    14

 */

    15

#define IRC_NICK_MAX (30 + 1)

    16

    17

/**

    18

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

    19

 *

    20

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

    21

 */

    22

#define IRC_PREFIX_MAX 510

    23

    24

/**

    25

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

    26

 */

    27

#define IRC_CHANFLAGS_MAX (8 + 1)

    28

    29

/**

    30

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

    31

 *

    32

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

    33

 */

    34

#define IRC_CHANFLAGS "@+"

    35

    36

/**

    37

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

    38

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

    39

 */

    40

struct irc_nm {

    41

    /** Nickname, not normalized */

    42

    const char *nickname;

    43

    44

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

    45

    const char *username;

    46

    47

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

    48

    const char *hostname;

    49

};

    50

    51

/**

    52

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

    53

 * inside \a nm.

    54

 */

    55

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

    56

    57

/**

    58

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

    59

 * returns pointers into that instead.

    60

 */

    61

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

    62

    63

/**

    64

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

    65

 */

    66

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

    67

    68

/**

    69

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

    70

 */

    71

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

    72

    73

/**

    74

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

    75

 */

    76

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

    77

    78

/**

    79

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

    80

 *

    81

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

    82

 */

    83

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

    84

    85

/**

    86

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

    87

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

    88

 *

    89

 * @param nickname the nickname including prefixed chanflags

    90

 * @param chanflags buffer to store the parsed chanflags into

    91

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

    92

 */

    93

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

    94

    95

/**

    96

 * @defgroup IRC_RPL_ IRC command numerics

    97

 * @{

    98

 */

    99

   100

/**

   101

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

   102

 *

   103

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

   104

 */

   105

#define IRC_RPL_WELCOME         "001"

   106

   107

/**

   108

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

   109

 *

   110

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

   111

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

   112

 *

   113

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

   114

 *  @   secret

   115

 *  *   private

   116

 *  =   others (public)

   117

 */

   118

#define IRC_RPL_NAMREPLY        "353"

   119

   120

/**

   121

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

   122

 *

   123

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

   124

 */

   125

#define IRC_RPL_ENDOFNAMES      "366"

   126

   127

// @}

   128

   129

#endif