- ngIRCd GIT Updates - lists.barton.de

Alexander Barton : Correctly detect errors when handling "MODE x" commands
by alex＠arthur.barton.de 14 Feb '11

14 Feb '11

Module: ngircd.git Branch: master Commit: adfa968f995c9f65130b96efef2cf389c1017efe URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=adfa968f… Author: Alexander Barton <alex(a)barton.de> Date: Mon Feb 14 01:44:40 2011 +0100 Correctly detect errors when handling "MODE x" commands --- src/ngircd/irc-mode.c | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/src/ngircd/irc-mode.c b/src/ngircd/irc-mode.c index 57af0bf..50b0db0 100644 --- a/src/ngircd/irc-mode.c +++ b/src/ngircd/irc-mode.c @@ -204,7 +204,7 @@ Client_Mode( CLIENT *Client, REQUEST *Req, CLIENT *Origin, CLIENT *Target ) case 'x': /* Cloak hostname */ if (Client_HasMode(Client, 'r')) - IRC_WriteStrClient(Origin, + ok = IRC_WriteStrClient(Origin, ERR_RESTRICTED_MSG, Client_ID(Origin)); else

1 0

Alexander Barton : Doxygen'ify irc-channel.c
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: 8a674c3263a2b4e0dfbac40acfd9e3320bbc5321 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=8a674c32… Author: Alexander Barton <alex(a)barton.de> Date: Wed Dec 29 13:11:20 2010 +0100 Doxygen'ify irc-channel.c --- src/ngircd/irc-channel.c | 121 ++++++++++++++++++++++++++++++++++++++++------ 1 files changed, 105 insertions(+), 16 deletions(-) diff --git a/src/ngircd/irc-channel.c b/src/ngircd/irc-channel.c index a7a273d..33ea68d 100644 --- a/src/ngircd/irc-channel.c +++ b/src/ngircd/irc-channel.c @@ -39,13 +39,18 @@ #include "irc-channel.h" -/* +/** + * Part from all channels. + * * RFC 2812, (3.2.1 Join message Command): - * Note that this message - * accepts a special argument ("0"), which is a special request to leave all - * channels the user is currently a member of. The server will process this - * message as if the user had sent a PART command (See Section 3.2.2) for - * each channel he is a member of. + * Note that this message accepts a special argument ("0"), which is a + * special request to leave all channels the user is currently a member of. + * The server will process this message as if the user had sent a PART + * command (See Section 3.2.2) for each channel he is a member of. + * + * @param client Client that initiated the part request + * @param target Client that should part all joined channels + * @returns CONNECTED or DISCONNECTED */ static bool part_from_all_channels(CLIENT* client, CLIENT *target) @@ -59,17 +64,18 @@ part_from_all_channels(CLIENT* client, CLIENT *target) Channel_Part(target, client, Channel_Name(chan), Client_ID(target)); } return CONNECTED; -} +} /* part_from_all_channels */ /** * Check weather a local client is allowed to join an already existing * channel or not. - * @param Client Client that sent the JOIN command - * @param chan Channel to check - * @param channame Name of the channel - * @param key Provided channel key (or NULL if none has been provided) - * @return true if client is allowed to join channel, false otherwise + * + * @param Client Client that sent the JOIN command + * @param chan Channel to check + * @param channame Name of the channel + * @param key Provided channel key (or NULL) + * @returns true if client is allowed to join, false otherwise */ static bool join_allowed(CLIENT *Client, CHANNEL *chan, const char *channame, @@ -132,9 +138,16 @@ join_allowed(CLIENT *Client, CHANNEL *chan, const char *channame, } return true; -} +} /* join_allowed */ +/** + * Set user channel modes. + * + * @param chan Channel + * @param target User to set modes for + * @param flags Channel modes to add + */ static void join_set_channelmodes(CHANNEL *chan, CLIENT *target, const char *flags) { @@ -148,9 +161,22 @@ join_set_channelmodes(CHANNEL *chan, CLIENT *target, const char *flags) /* If channel persistent and client is ircop: make client chanop */ if (strchr(Channel_Modes(chan), 'P') && strchr(Client_Modes(target), 'o')) Channel_UserModeAdd(chan, target, 'o'); -} +} /* join_set_channelmodes */ +/** + * Forward JOIN command to a specific server + * + * This function diffentiates between servers using RFC 2813 mode that + * support the JOIN command with appended ASCII 7 character and channel + * modes, and servers using RFC 1459 protocol which require separate JOIN + * and MODE commands. + * + * @param To Forward JOIN (and MODE) command to this peer server + * @param Prefix Client used to prefix the genrated commands + * @param Data Parameters of JOIN command to forward, probably + * containing channel modes separated by ASCII 7. + */ static void cb_join_forward(CLIENT *To, CLIENT *Prefix, void *Data) { @@ -175,12 +201,25 @@ cb_join_forward(CLIENT *To, CLIENT *Prefix, void *Data) } /* cb_join_forward */ +/** + * Forward JOIN command to all servers + * + * This function calls cb_join_forward(), which differentiates between + * protocol implementations (e.g. RFC 2812, RFC 1459). + * + * @param Client Client used to prefix the genrated commands + * @param target Forward JOIN (and MODE) command to this peer server + * @param chan Channel structure + * @param channame Channel name + */ static void join_forward(CLIENT *Client, CLIENT *target, CHANNEL *chan, const char *channame) { char modes[CHANNEL_MODE_LEN], str[COMMAND_LEN]; + /* RFC 2813, 4.2.1: channel modes are separated from the channel + * name with ASCII 7, if any, and not spaces: */ strlcpy(&modes[1], Channel_UserModes(chan, target), sizeof(modes) - 1); if (modes[1]) modes[0] = 0x7; @@ -207,6 +246,14 @@ join_forward(CLIENT *Client, CLIENT *target, CHANNEL *chan, } /* join_forward */ +/** + * Aknowledge user JOIN request and send "channel info" numerics. + * + * @param Client Client used to prefix the genrated commands + * @param target Forward commands/numerics to this user + * @param chan Channel structure + * @param channame Channel name + */ static bool join_send_topic(CLIENT *Client, CLIENT *target, CHANNEL *chan, const char *channame) @@ -237,10 +284,20 @@ join_send_topic(CLIENT *Client, CLIENT *target, CHANNEL *chan, /* send list of channel members to client */ if (!IRC_Send_NAMES(Client, chan)) return false; - return IRC_WriteStrClient(Client, RPL_ENDOFNAMES_MSG, Client_ID(Client), Channel_Name(chan)); -} + return IRC_WriteStrClient(Client, RPL_ENDOFNAMES_MSG, Client_ID(Client), + Channel_Name(chan)); +} /* join_send_topic */ +/** + * Handler for the IRC "JOIN" command. + * + * See RFC 2812, 3.2.1 "Join message"; RFC 2813, 4.2.1 "Join message". + * + * @param Client The client from which this command has been received + * @param Req Request structure with prefix and all parameters + * @returns CONNECTED or DISCONNECTED + */ GLOBAL bool IRC_JOIN( CLIENT *Client, REQUEST *Req ) { @@ -365,6 +422,12 @@ IRC_JOIN( CLIENT *Client, REQUEST *Req ) /** * Handler for the IRC "PART" command. + * + * See RFC 2812, 3.2.2: "Part message". + * + * @param Client The client from which this command has been received + * @param Req Request structure with prefix and all parameters + * @returns CONNECTED or DISCONNECTED */ GLOBAL bool IRC_PART(CLIENT * Client, REQUEST * Req) @@ -410,6 +473,15 @@ IRC_PART(CLIENT * Client, REQUEST * Req) } /* IRC_PART */ +/** + * Handler for the IRC "TOPIC" command. + * + * See RFC 2812, 3.2.4 "Topic message". + * + * @param Client The client from which this command has been received + * @param Req Request structure with prefix and all parameters + * @returns CONNECTED or DISCONNECTED + */ GLOBAL bool IRC_TOPIC( CLIENT *Client, REQUEST *Req ) { @@ -502,8 +574,15 @@ IRC_TOPIC( CLIENT *Client, REQUEST *Req ) /** * Handler for the IRC "LIST" command. + * + * See RFC 2812, 3.2.6 "List message". + * * This implementation handles the local case as well as the forwarding of the * LIST command to other servers in the IRC network. + * + * @param Client The client from which this command has been received + * @param Req Request structure with prefix and all parameters + * @returns CONNECTED or DISCONNECTED */ GLOBAL bool IRC_LIST( CLIENT *Client, REQUEST *Req ) @@ -587,6 +666,16 @@ IRC_LIST( CLIENT *Client, REQUEST *Req ) } /* IRC_LIST */ +/** + * Handler for the IRC+ command "CHANINFO". + * + * See doc/Protocol.txt, section II.3: + * "Exchange channel-modes, topics, and persistent channels". + * + * @param Client The client from which this command has been received + * @param Req Request structure with prefix and all parameters + * @returns CONNECTED or DISCONNECTED + */ GLOBAL bool IRC_CHANINFO( CLIENT *Client, REQUEST *Req ) {

1 0

Alexander Barton : Doxygen'ify irc-login.c
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: 53fecf5a2b3e0f396b08b2a00a73eb73c46e1853 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=53fecf5a… Author: Alexander Barton <alex(a)barton.de> Date: Wed Dec 29 14:09:46 2010 +0100 Doxygen'ify irc-login.c --- src/ngircd/irc-login.c | 113 ++++++++++++++++++++++++++++++++++++++++++++++-- 1 files changed, 109 insertions(+), 4 deletions(-) diff --git a/src/ngircd/irc-login.c b/src/ngircd/irc-login.c index a0f16a9..1557f18 100644 --- a/src/ngircd/irc-login.c +++ b/src/ngircd/irc-login.c @@ -56,8 +56,13 @@ static void cb_Read_Auth_Result PARAMS((int r_fd, UNUSED short events)); #endif /** - * Handler for the IRC command "PASS". + * Handler for the IRC "PASS" command. + * * See RFC 2813 section 4.1.1, and RFC 2812 section 3.1.1. + * + * @param Client The client from which this command has been received. + * @param Req Request structure with prefix and all parameters. + * @returns CONNECTED or DISCONNECTED. */ GLOBAL bool IRC_PASS( CLIENT *Client, REQUEST *Req ) @@ -176,10 +181,17 @@ IRC_PASS( CLIENT *Client, REQUEST *Req ) /** - * IRC "NICK" command. + * Handler for the IRC "NICK" command. + * + * See RFC 2812, 3.1.2 "Nick message", and RFC 2813, 4.1.3 "Nick". + * * This function implements the IRC command "NICK" which is used to register * with the server, to change already registered nicknames and to introduce * new users which are connected to other servers. + * + * @param Client The client from which this command has been received. + * @param Req Request structure with prefix and all parameters. + * @returns CONNECTED or DISCONNECTED. */ GLOBAL bool IRC_NICK( CLIENT *Client, REQUEST *Req ) @@ -381,7 +393,13 @@ IRC_NICK( CLIENT *Client, REQUEST *Req ) /** - * Handler for the IRC command "USER". + * Handler for the IRC "USER" command. + * + * See RFC 2812, 3.1.3 "User message". + * + * @param Client The client from which this command has been received. + * @param Req Request structure with prefix and all parameters. + * @returns CONNECTED or DISCONNECTED. */ GLOBAL bool IRC_USER(CLIENT * Client, REQUEST * Req) @@ -474,12 +492,18 @@ IRC_USER(CLIENT * Client, REQUEST * Req) /** - * Handler for the IRC command "SERVICE". + * Handler for the IRC "SERVICE" command. + * * This function implements IRC Services registration using the SERVICE command * defined in RFC 2812 3.1.6 and RFC 2813 4.1.4. + * * At the moment ngIRCd doesn't support directly linked services, so this * function returns ERR_ERRONEUSNICKNAME when the SERVICE command has not been * received from a peer server. + * + * @param Client The client from which this command has been received. + * @param Req Request structure with prefix and all parameters. + * @returns CONNECTED or DISCONNECTED.. */ GLOBAL bool IRC_SERVICE(CLIENT *Client, REQUEST *Req) @@ -597,6 +621,15 @@ IRC_WEBIRC(CLIENT *Client, REQUEST *Req) } /* IRC_WEBIRC */ +/** + * Handler for the IRC "QUIT" command. + * + * See RFC 2812, 3.1.7 "Quit", and RFC 2813, 4.1.5 "Quit". + * + * @param Client The client from which this command has been received. + * @param Req Request structure with prefix and all parameters. + * @returns CONNECTED or DISCONNECTED. + */ GLOBAL bool IRC_QUIT( CLIENT *Client, REQUEST *Req ) { @@ -644,6 +677,15 @@ IRC_QUIT( CLIENT *Client, REQUEST *Req ) } /* IRC_QUIT */ +/** + * Handler for the IRC "PING" command. + * + * See RFC 2812, 3.7.2 "Ping message". + * + * @param Client The client from which this command has been received. + * @param Req Request structure with prefix and all parameters. + * @returns CONNECTED or DISCONNECTED. + */ GLOBAL bool IRC_PING(CLIENT *Client, REQUEST *Req) { @@ -713,6 +755,15 @@ IRC_PING(CLIENT *Client, REQUEST *Req) } /* IRC_PING */ +/** + * Handler for the IRC "PONG" command. + * + * See RFC 2812, 3.7.3 "Pong message". + * + * @param Client The client from which this command has been received. + * @param Req Request structure with prefix and all parameters. + * @returns CONNECTED or DISCONNECTED. + */ GLOBAL bool IRC_PONG(CLIENT *Client, REQUEST *Req) { @@ -771,6 +822,17 @@ IRC_PONG(CLIENT *Client, REQUEST *Req) } /* IRC_PONG */ +/** + * Initiate client registration. + * + * This function is called after the daemon received the required NICK and + * USER commands of a new client. If the daemon is compiled with support for + * PAM, the authentication sub-processs is forked; otherwise the global server + * password is checked. + * + * @param Client The client logging in. + * @returns CONNECTED or DISCONNECTED. + */ static bool Hello_User(CLIENT * Client) { @@ -827,6 +889,9 @@ Hello_User(CLIENT * Client) /** * Read result of the authenticatior sub-process from pipe + * + * @param r_fd File descriptor of the pipe. + * @param events (ignored IO specification) */ static void cb_Read_Auth_Result(int r_fd, UNUSED short events) @@ -870,6 +935,14 @@ cb_Read_Auth_Result(int r_fd, UNUSED short events) #endif +/** + * Reject a client because of wrong password. + * + * This function is called either when the global server password or a password + * checked using PAM has been wrong. + * + * @param Client The client to reject. + */ static void Reject_Client(CLIENT *Client) { @@ -881,6 +954,15 @@ Reject_Client(CLIENT *Client) } +/** + * Finish client registration. + * + * Introduce the new client to the network and send all "hello messages" + * to it after authentication has been succeeded. + * + * @param Client The client logging in. + * @returns CONNECTED or DISCONNECTED. + */ static bool Hello_User_PostAuth(CLIENT *Client) { @@ -920,6 +1002,12 @@ Hello_User_PostAuth(CLIENT *Client) } +/** + * Kill all users with a specific nick name in the network. + * + * @param Nick Nick name. + * @param Reason Reason for the KILL. + */ static void Kill_Nick( char *Nick, char *Reason ) { @@ -938,6 +1026,13 @@ Kill_Nick( char *Nick, char *Reason ) } /* Kill_Nick */ +/** + * Introduce a new user or service client in the network. + * + * @param From Remote server introducing the client or NULL (local). + * @param Client New client. + * @param Type Type of the client (CLIENT_USER or CLIENT_SERVICE). + */ static void Introduce_Client(CLIENT *From, CLIENT *Client, int Type) { @@ -971,6 +1066,16 @@ Introduce_Client(CLIENT *From, CLIENT *Client, int Type) } /* Introduce_Client */ +/** + * Introduce a new user or service client to a remote server. + * + * This function differentiates between RFC1459 and RFC2813 server links and + * generates the appropriate commands to register the new user or service. + * + * @param To The remote server to inform. + * @param Prefix Prefix for the generated commands. + * @param data CLIENT structure of the new client. + */ static void cb_introduceClient(CLIENT *To, CLIENT *Prefix, void *data) {

1 0

Alexander Barton : Enhance documentation for the WEBIRC command
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: 07f241ff6d3afee88d6c6b3e2ed1e195c0367c91 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=07f241ff… Author: Alexander Barton <alex(a)barton.de> Date: Wed Dec 29 14:10:18 2010 +0100 Enhance documentation for the WEBIRC command --- doc/Protocol.txt | 14 ++++++++++++++ src/ngircd/irc-login.c | 10 ++++++++-- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/doc/Protocol.txt b/doc/Protocol.txt index 354b814..2b7e7b8 100644 --- a/doc/Protocol.txt +++ b/doc/Protocol.txt @@ -161,3 +161,17 @@ and therefore can't be omitted. The parameter <limit> must be ignored when a channel has no user limit (the parameter <modes> doesn't list the "l" channel mode). In this case <limit> should be "0". + +II.4 Update webchat/proxy client information + + Command: WEBIRC + Parameters: <password> <username> <hostname> <ip-address> + Used by: unregistered clients only + +The WEBIRC command is used by some Web-to-IRC gateways to set the correct +user name and host name of users instead of their own. It must be the very +first command sent to the server, even before USER and NICK commands! + +The <password> must be set in the server configuration file to prevent +unauthorized clients to fake their identity; it is an arbitrary string. + diff --git a/src/ngircd/irc-login.c b/src/ngircd/irc-login.c index 1557f18..6a97074 100644 --- a/src/ngircd/irc-login.c +++ b/src/ngircd/irc-login.c @@ -596,8 +596,14 @@ IRC_SERVICE(CLIENT *Client, REQUEST *Req) /** - * Handler for the IRC command "WEBIRC". - * Syntax: WEBIRC <password> <username> <real-hostname> <real-IP-address> + * Handler for the IRC "WEBIRC" command. + * + * See doc/Protocol.txt, section II.4: + * "Update webchat/proxy client information". + * + * @param Client The client from which this command has been received. + * @param Req Request structure with prefix and all parameters. + * @returns CONNECTED or DISCONNECTED. */ GLOBAL bool IRC_WEBIRC(CLIENT *Client, REQUEST *Req)

1 0

Alexander Barton : Update and translate comments in hash.c
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: 4ef23df8137557cee0e657d5b05fa09c4c61c6ca URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=4ef23df8… Author: Alexander Barton <alex(a)barton.de> Date: Mon Dec 27 17:27:21 2010 +0100 Update and translate comments in hash.c --- src/ngircd/hash.c | 19 +++++++++++-------- 1 files changed, 11 insertions(+), 8 deletions(-) diff --git a/src/ngircd/hash.c b/src/ngircd/hash.c index eb980d1..113133d 100644 --- a/src/ngircd/hash.c +++ b/src/ngircd/hash.c @@ -26,15 +26,18 @@ #include "exp.h" #include "hash.h" +static UINT32 jenkins_hash PARAMS((register UINT8 *k, register UINT32 length, + register UINT32 initval)); -static UINT32 jenkins_hash PARAMS(( register UINT8 *k, register UINT32 length, register UINT32 initval )); - - +/** + * Calculate hash value for a given string. + * + * @param String Input string + * @return 32 bit hash value + */ GLOBAL UINT32 Hash( const char *String ) { - /* Hash-Wert ueber String berechnen */ - char buffer[LINE_LEN]; strlcpy(buffer, String, sizeof(buffer)); @@ -43,15 +46,15 @@ Hash( const char *String ) } /* Hash */ /* - * Die hier verwendete Hash-Funktion stammt aus lookup2.c von Bob Jenkins - * (URL: <http://burtleburtle.net/bob/c/lookup2.c>). Aus dem Header: + * This hash function originates from lookup2.c of Bob Jenkins + * (URL: <http://burtleburtle.net/bob/c/lookup2.c>): * -------------------------------------------------------------------- * lookup2.c, by Bob Jenkins, December 1996, Public Domain. * hash(), hash2(), hash3, and mix() are externally useful functions. * Routines to test the hash are included if SELF_TEST is defined. * You can use this free for any purpose. It has no warranty. * -------------------------------------------------------------------- - * nicht alle seiner Funktionen werden hier genutzt. + * Not all of his functions are used here. */ #define hashsize(n) ((UINT32)1<<(n))

1 0

Alexander Barton : Doxygen'ify and update comments in match.c
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: c6a7de869cce97c88d813921304a2c5498273e1e URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=c6a7de86… Author: Alexander Barton <alex(a)barton.de> Date: Mon Dec 27 17:28:30 2010 +0100 Doxygen'ify and update comments in match.c --- src/ngircd/match.c | 33 +++++++++++++++++++++++---------- 1 files changed, 23 insertions(+), 10 deletions(-) diff --git a/src/ngircd/match.c b/src/ngircd/match.c index 162a4f2..79699ea 100644 --- a/src/ngircd/match.c +++ b/src/ngircd/match.c @@ -27,10 +27,9 @@ /* - * Die Pattern-Matching-Funkionen [Matche(), Matche_After_Star()] basieren - * auf Versionen von J. Kercheval. Die Version 1.1 wurde am 12.03.1991 als - * "public domain" freigegeben: - * <http://www.snippets.org/snippets/portable/MATCH+C.php3> + * The pattern matching functions [Matche(), Matche_After_Star()] are based + * on code of J. Kercheval. Version 1.1 has been released on 1991-03-12 as + * "public domain": <http://c.snippets.org/snip_lister.php?fname=match.c> */ @@ -38,14 +37,21 @@ static int Matche PARAMS(( const char *p, const char *t )); static int Matche_After_Star PARAMS(( const char *p, const char *t )); -#define MATCH_PATTERN 6 /* bad pattern */ -#define MATCH_LITERAL 5 /* match failure on literal match */ -#define MATCH_RANGE 4 /* match failure on [..] construct */ -#define MATCH_ABORT 3 /* premature end of text string */ -#define MATCH_END 2 /* premature end of pattern string */ -#define MATCH_VALID 1 /* valid match */ +#define MATCH_PATTERN 6 /**< bad pattern */ +#define MATCH_LITERAL 5 /**< match failure on literal match */ +#define MATCH_RANGE 4 /**< match failure on [..] construct */ +#define MATCH_ABORT 3 /**< premature end of text string */ +#define MATCH_END 2 /**< premature end of pattern string */ +#define MATCH_VALID 1 /**< valid match */ +/** + * Match string with pattern. + * + * @param Pattern Pattern to match with + * @param String Input string + * @return true if pattern matches + */ GLOBAL bool Match( const char *Pattern, const char *String ) { @@ -55,6 +61,13 @@ Match( const char *Pattern, const char *String ) } /* Match */ +/** + * Match string with pattern case-insensitive. + * + * @param pattern Pattern to match with + * @param searchme Input string, at most COMMAND_LEN-1 characters long + * @return true if pattern matches + */ GLOBAL bool MatchCaseInsensitive(const char *pattern, const char *searchme) {

1 0

Alexander Barton : Doxygen'ify and update comments in ngircd.{c|h}
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: f3ec90f3f0e3e3b3ccfddda209ac94ba5ad92e42 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=f3ec90f3… Author: Alexander Barton <alex(a)barton.de> Date: Mon Dec 27 17:31:19 2010 +0100 Doxygen'ify and update comments in ngircd.{c|h} --- src/ngircd/ngircd.c | 54 ++++++++++++++++++++++++++++++++++----------------- src/ngircd/ngircd.h | 41 +++++++++++++++++++++++++++++--------- 2 files changed, 67 insertions(+), 28 deletions(-) diff --git a/src/ngircd/ngircd.c b/src/ngircd/ngircd.c index e595caf..4b49ec6 100644 --- a/src/ngircd/ngircd.c +++ b/src/ngircd/ngircd.c @@ -67,11 +67,13 @@ static bool NGIRCd_Init PARAMS(( bool )); /** * The main() function of ngIRCd. + * * Here all starts: this function is called by the operating system loader, * it is the first portion of code executed of ngIRCd. - * @param argc The number of arguments passed to ngIRCd on the command line. - * @param argv An array containing all the arguments passed to ngIRCd. - * @return Global exit code of ngIRCd, zero on success. + * + * @param argc The number of arguments passed to ngIRCd on the command line. + * @param argv An array containing all the arguments passed to ngIRCd. + * @return Global exit code of ngIRCd, zero on success. */ GLOBAL int main( int argc, const char *argv[] ) @@ -232,7 +234,7 @@ main( int argc, const char *argv[] ) } } - /* Debug-Level (for IRCs "VERSION" command) */ + /* Debug level for "VERSION" command */ NGIRCd_DebugLevel[0] = '\0'; #ifdef DEBUG if( NGIRCd_Debug ) strcpy( NGIRCd_DebugLevel, "1" ); @@ -287,11 +289,9 @@ main( int argc, const char *argv[] ) exit(1); } - /* - * create protocol and server identification. - * The syntax used by ngIRCd in PASS commands and the extended flags - * are described in doc/Protocol.txt - */ + /* Create protocol and server identification. The syntax + * used by ngIRCd in PASS commands and the known "extended + * flags" are described in doc/Protocol.txt. */ #ifdef IRCPLUS snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s:%s", PROTOVER, PROTOIRCPLUS, PACKAGE_NAME, PACKAGE_VERSION, IRCPLUSFLAGS ); #ifdef ZLIB @@ -316,11 +316,10 @@ main( int argc, const char *argv[] ) Pidfile_Delete( ); exit( 1 ); } - - /* Hauptschleife */ + + /* Main Run Loop */ Conn_Handler( ); - /* Alles abmelden */ Conn_Exit( ); Client_Exit( ); Channel_Exit( ); @@ -333,10 +332,12 @@ main( int argc, const char *argv[] ) /** - * Generate ngIRCd "version string". - * This string is generated once and then stored in NGIRCd_Version for - * further usage, for example by the IRC command VERSION and the --version - * command line switch. + * Generate ngIRCd "version strings". + * + * The ngIRCd version information is generated once and then stored in the + * NGIRCd_Version and NGIRCd_VersionAddition string variables for further + * usage, for example by the IRC command "VERSION" and the --version command + * line switch. */ static void Fill_Version( void ) @@ -466,7 +467,8 @@ Pidfile_Delete( void ) /** * Create the file containing the process ID of ngIRCd ("PID file"). - * @param pid The process ID to be stored in this file. + * + * @param pid The process ID to be stored in this file. */ static void Pidfile_Create(pid_t pid) @@ -504,6 +506,8 @@ Pidfile_Create(pid_t pid) /** * Redirect stdin, stdout and stderr to apropriate file handles. + * + * @param fd The file handle stdin, stdout and stderr should be redirected to. */ static void Setup_FDStreams(int fd) @@ -519,6 +523,13 @@ Setup_FDStreams(int fd) } /* Setup_FDStreams */ +/** + * Get user and group ID of unprivileged "nobody" user. + * + * @param uid User ID + * @param gid Group ID + * @return true on success. + */ static bool NGIRCd_getNobodyID(uid_t *uid, gid_t *gid ) { @@ -543,7 +554,7 @@ NGIRCd_getNobodyID(uid_t *uid, gid_t *gid ) if ( !pwd->pw_uid || !pwd->pw_gid) return false; - *uid = pwd->pw_uid; + *uid = pwd->pw_uid; *gid = pwd->pw_gid; endpwent(); @@ -551,6 +562,13 @@ NGIRCd_getNobodyID(uid_t *uid, gid_t *gid ) } /* NGIRCd_getNobodyID */ +/** + * Initialize ngIRCd daemon. + * + * @param NGIRCd_NoDaemon Set to true if ngIRCd should run in the + * foreground and not as a daemon. + * @return true on success. + */ static bool NGIRCd_Init( bool NGIRCd_NoDaemon ) { diff --git a/src/ngircd/ngircd.h b/src/ngircd/ngircd.h index 143a9ff..2efb8a9 100644 --- a/src/ngircd/ngircd.h +++ b/src/ngircd/ngircd.h @@ -1,6 +1,6 @@ /* * ngIRCd -- The Next Generation IRC Daemon - * Copyright (c)2001,2002 by Alexander Barton (alex(a)barton.de) + * Copyright (c)2001-2010 Alexander Barton (alex(a)barton.de) * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -23,31 +23,52 @@ #define C_ARRAY_SIZE(x) (sizeof(x)/sizeof((x)[0])) +/** UNIX timestamp of ngIRCd start */ +GLOBAL time_t NGIRCd_Start; -GLOBAL time_t NGIRCd_Start; /* Startzeitpunkt des Daemon */ +/** ngIRCd start time as string, used for RPL_CREATED_MSG (003) */ GLOBAL char NGIRCd_StartStr[64]; + +/** ngIRCd version number containing release number and compile-time options */ GLOBAL char NGIRCd_Version[126]; + +/** String specifying the compile-time options and target platform */ GLOBAL char NGIRCd_VersionAddition[126]; #ifdef DEBUG -GLOBAL bool NGIRCd_Debug; /* Debug-Modus aktivieren */ +/** Flag indicating if debug mode is active (true) or not (false) */ +GLOBAL bool NGIRCd_Debug; #endif #ifdef SNIFFER -GLOBAL bool NGIRCd_Sniffer; /* Sniffer aktivieren */ +/** Flag indication if sniffer is active (true) or not (false) */ +GLOBAL bool NGIRCd_Sniffer; #endif -GLOBAL bool NGIRCd_Passive; /* nicht zu anderen Servern connecten */ +/** + * Flag indicating if NO outgoing connections should be established (true) + * or not (false, the default) + */ +GLOBAL bool NGIRCd_Passive; -GLOBAL bool NGIRCd_SignalQuit; /* true: quit server*/ -GLOBAL bool NGIRCd_SignalRestart; /* true: restart server */ +/** Flag indicating that ngIRCd has been requested to quit (true) */ +GLOBAL bool NGIRCd_SignalQuit; -GLOBAL char NGIRCd_DebugLevel[2]; /* Debug-Level fuer IRC_VERSION() */ +/** Flag indicating that ngIRCd has been requested to restart (true) */ +GLOBAL bool NGIRCd_SignalRestart; -GLOBAL char NGIRCd_ConfFile[FNAME_LEN]; /* Konfigurationsdatei */ +/** + * Debug level for "VERSION" command, see description of numeric RPL_VERSION + * (351) in RFC 2812. ngIRCd sets debuglevel to 1 when the debug mode is + * active, and to 2 if the sniffer is running. + */ +GLOBAL char NGIRCd_DebugLevel[2]; -GLOBAL char NGIRCd_ProtoID[COMMAND_LEN];/* Protokoll- und Server-Identifikation */ +/** Full path and file name of current configuration file */ +GLOBAL char NGIRCd_ConfFile[FNAME_LEN]; +/** Protocol and server identification string; see doc/Protocol.txt */ +GLOBAL char NGIRCd_ProtoID[COMMAND_LEN]; #endif

1 0

Alexander Barton : Doxygen'ify parse.h
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: af6ac0fa41a10889cdaf9898d995980bebcefec1 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=af6ac0fa… Author: Alexander Barton <alex(a)barton.de> Date: Mon Dec 27 17:34:26 2010 +0100 Doxygen'ify parse.h --- src/ngircd/parse.h | 22 ++++++++++++---------- 1 files changed, 12 insertions(+), 10 deletions(-) diff --git a/src/ngircd/parse.h b/src/ngircd/parse.h index 3acab7d..0c6f8a6 100644 --- a/src/ngircd/parse.h +++ b/src/ngircd/parse.h @@ -19,22 +19,24 @@ #include "portab.h" -typedef struct _REQUEST /* vgl. RFC 2812, 2.3 */ +/** A single IRC request ("command"). See RFC 2812 section 2.3 for details. */ +typedef struct _REQUEST { - char *prefix; /* Prefix */ - char *command; /* IRC-Befehl */ - char *argv[15]; /* Parameter (max. 15: 0..14) */ - int argc; /* Anzahl vorhandener Parameter */ + char *prefix; /**< Prefix */ + char *command; /**< IRC command */ + char *argv[15]; /**< Parameters, at most 15 (0..14) */ + int argc; /**< Number of given paramaters */ } REQUEST; - +/** IRC command handling structure */ typedef struct _COMMAND { - const char *name; /* command name */ + const char *name; /**< Command name */ bool (*function) PARAMS(( CLIENT *Client, REQUEST *Request )); - CLIENT_TYPE type; /* valid client types (bit mask) */ - long lcount, rcount; /* number of local and remote calls */ - long bytes; /* number of bytes created */ + /**< Function to handle this command */ + CLIENT_TYPE type; /**< Valid client types (bit mask) */ + long lcount, rcount; /**< Number of local and remote calls */ + long bytes; /**< Number of bytes created */ } COMMAND; GLOBAL bool Parse_Request PARAMS((CONN_ID Idx, char *Request ));

1 0

Alexander Barton : Doxygen'ify proc.h
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: 5858dc3886e492f96a42b61decdda3c1acd920a4 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=5858dc38… Author: Alexander Barton <alex(a)barton.de> Date: Mon Dec 27 17:37:56 2010 +0100 Doxygen'ify proc.h --- src/ngircd/proc.h | 7 +++++-- 1 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/ngircd/proc.h b/src/ngircd/proc.h index bb4bceb..84b61f2 100644 --- a/src/ngircd/proc.h +++ b/src/ngircd/proc.h @@ -19,11 +19,14 @@ /** Process status. This struct must not be accessed directly! */ typedef struct _Proc_Stat { - pid_t pid; /* PID of the child process or 0 if none */ - int pipe_fd; /* Pipe file descriptor or -1 if none */ + pid_t pid; /**< PID of the child process or 0 if none */ + int pipe_fd; /**< Pipe file descriptor or -1 if none */ } PROC_STAT; +/** Return true if sub-process is still running */ #define Proc_InProgress(x) ((x)->pid != 0) + +/** Return file descriptor of pipe to sub-process (or -1 if none open) */ #define Proc_GetPipeFd(x) ((x)->pipe_fd) GLOBAL void Proc_InitStruct PARAMS((PROC_STAT *proc));

1 0

Alexander Barton : Doxygen'ify conn.c
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: 1f5fbd5992d447c5814171ddb907f4268566a1f5 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=1f5fbd59… Author: Alexander Barton <alex(a)barton.de> Date: Wed Dec 29 13:09:01 2010 +0100 Doxygen'ify conn.c --- src/ngircd/conn.c | 241 +++++++++++++++++++++++++++++++++++++++++++---------- 1 files changed, 195 insertions(+), 46 deletions(-) Diff: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commitdiff;h=1f5f…

1 0