- ngIRCd GIT Updates - lists.barton.de

Alexander Barton : autogen.sh: Reformat messages.
by alex＠arthur.barton.de 05 Jan '13

05 Jan '13

Module: ngircd.git Branch: master Commit: 4594583f52c46105ffd77eaaf4d9784809567324 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=4594583f… Author: Alexander Barton <alex(a)barton.de> Date: Sat Jan 5 02:37:55 2013 +0100 autogen.sh: Reformat messages. --- autogen.sh | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/autogen.sh b/autogen.sh index 6c2a8dd..cc4bddf 100755 --- a/autogen.sh +++ b/autogen.sh @@ -1,7 +1,7 @@ #!/bin/sh # # ngIRCd -- The Next Generation IRC Daemon -# Copyright (c)2001-2012 Alexander Barton (alex(a)barton.de) and Contributors +# Copyright (c)2001-2013 Alexander Barton (alex(a)barton.de) and Contributors # # 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 @@ -156,21 +156,23 @@ echo "Searching for required tools ..." AM_VERSION=`$AUTOMAKE --version|head -n 1|egrep -o "([1-9]\.[0-9]+(\.[0-9]+)*)"` ifs=$IFS; IFS="."; set $AM_VERSION; IFS=$ifs AM_MAJOR="$1"; AM_MINOR="$2"; AM_PATCHLEVEL="$3" +echo "Detected automake $AM_VERSION ..." AM_MAKEFILES="src/ipaddr/Makefile.ng src/ngircd/Makefile.ng src/testsuite/Makefile.ng src/tool/Makefile.ng" +# De-ANSI-fication? if [ "$AM_MAJOR" -eq "1" -a "$AM_MINOR" -lt "12" ]; then # automake < 1.12 => automatic de-ANSI-fication support available - echo "Enabling de-ANSI-fication support (automake $AM_VERSION) ..." + echo " - Enabling de-ANSI-fication support." sed -e "s|^__ng_PROTOTYPES__|AM_C_PROTOTYPES|g" configure.ng >configure.ac DEANSI_START="" DEANSI_END="" else # automake >= 1.12 => no de-ANSI-fication support available - echo "Disabling de-ANSI-fication support (automake $AM_VERSION) ..." + echo " - Disabling de-ANSI-fication support." sed -e "s|^__ng_PROTOTYPES__|AC_C_PROTOTYPES|g" configure.ng >configure.ac DEANSI_START="#" - DEANSI_END=" # disabled by ./autogen.sh script" + DEANSI_END=" (disabled by ./autogen.sh script)" fi sed -e "s|^__ng_Makefile_am_template__|${DEANSI_START}AUTOMAKE_OPTIONS = ansi2knr${DEANSI_END}|g" \ src/portab/Makefile.ng >src/portab/Makefile.am

1 0

Alexander Barton : autogen.sh: Enforce serial test harness on automake >=1. 13
by alex＠arthur.barton.de 05 Jan '13

05 Jan '13

Module: ngircd.git Branch: master Commit: 0703fcd71983bd04f70101fd0143660174d22f84 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=0703fcd7… Author: Alexander Barton <alex(a)barton.de> Date: Sat Jan 5 03:05:56 2013 +0100 autogen.sh: Enforce serial test harness on automake >=1.13 --- autogen.sh | 14 ++++++++++++-- configure.ng | 3 ++- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/autogen.sh b/autogen.sh index cc4bddf..b1fa883 100755 --- a/autogen.sh +++ b/autogen.sh @@ -174,11 +174,21 @@ else DEANSI_START="#" DEANSI_END=" (disabled by ./autogen.sh script)" fi -sed -e "s|^__ng_Makefile_am_template__|${DEANSI_START}AUTOMAKE_OPTIONS = ansi2knr${DEANSI_END}|g" \ +# Serial test harness? +if [ "$AM_MAJOR" -eq "1" -a "$AM_MINOR" -ge "13" ]; then + # automake >= 1.13 => enforce "serial test harness" + echo " - Enforcing serial test harness." + SERIAL_TESTS="serial-tests" +else + # automake < 1.13 => no new test harness, nothing to do + SERIAL_TEST="" +fi + +sed -e "s|^__ng_Makefile_am_template__|AUTOMAKE_OPTIONS = ${SERIAL_TESTS} ${DEANSI_START}ansi2knr${DEANSI_END}|g" \ src/portab/Makefile.ng >src/portab/Makefile.am for makefile_ng in $AM_MAKEFILES; do makefile_am=`echo "$makefile_ng" | sed -e "s|\.ng\$|\.am|g"` - sed -e "s|^__ng_Makefile_am_template__|${DEANSI_START}AUTOMAKE_OPTIONS = ../portab/ansi2knr${DEANSI_END}|g" \ + sed -e "s|^__ng_Makefile_am_template__|AUTOMAKE_OPTIONS = ${SERIAL_TESTS} ${DEANSI_START}../portab/ansi2knr${DEANSI_END}|g" \ $makefile_ng >$makefile_am done diff --git a/configure.ng b/configure.ng index 732e55e..47c9599 100644 --- a/configure.ng +++ b/configure.ng @@ -711,7 +711,8 @@ echo $ECHO_N " libiconv support: $ECHO_C" echo -if ! grep "^AUTOMAKE_OPTIONS = ../portab/ansi2knr" src/ngircd/Makefile.am >/dev/null 2>&1; then +define(_automake_regex_,[[^AUTOMAKE_OPTIONS = [a-z .\-]*/portab/ansi2knr]]) +if ! grep "_automake_regex_" src/ngircd/Makefile.am >/dev/null 2>&1; then echo "WARNING:" echo "This GNU automake generated build system does not support \"de-ANSI-fication\"," echo "therefore don't use it to generate \"official\" distribution archives!"

1 0

Alexander Barton : Add a note that "help file" is updated on startup and REHASH only
by alex＠arthur.barton.de 02 Jan '13

02 Jan '13

Module: ngircd.git Branch: master Commit: 60a9a7f11860a3953d215a377d31714e02d09eba URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=60a9a7f1… Author: Alexander Barton <alex(a)barton.de> Date: Tue Jan 1 15:35:49 2013 +0100 Add a note that "help file" is updated on startup and REHASH only --- man/ngircd.conf.5.tmpl | 2 ++ 1 file changed, 2 insertions(+) diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl index 681e86c..859c6a8 100644 --- a/man/ngircd.conf.5.tmpl +++ b/man/ngircd.conf.5.tmpl @@ -104,6 +104,8 @@ command. This information is not required by the server but by RFC! \fBHelpFile\fR (string) Text file which contains the ngIRCd help text. This file is required to display help texts when using the "HELP <cmd>" command. +Please note: Changes made to this file take effect when ngircd starts up +or is instructed to re-read its configuration file. .TP \fBInfo\fR (string) Info text of the server. This will be shown by WHOIS and LINKS requests for

1 0

Alexander Barton : Use "${docdir}/Commands.txt" as help text file
by alex＠arthur.barton.de 02 Jan '13

02 Jan '13

Module: ngircd.git Branch: master Commit: 950aeec3ff0e15c456ac32d8fecee8c73f7c5df3 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=950aeec3… Author: Alexander Barton <alex(a)barton.de> Date: Tue Jan 1 19:25:06 2013 +0100 Use "${docdir}/Commands.txt" as help text file --- configure.ng | 4 ++-- contrib/MacOSX/config.h | 3 ++- doc/Makefile.am | 3 ++- doc/sample-ngircd.conf.tmpl | 2 +- src/ngircd/conf.c | 4 ++-- src/ngircd/defines.h | 2 +- 6 files changed, 10 insertions(+), 8 deletions(-) diff --git a/configure.ng b/configure.ng index 84e2750..732e55e 100644 --- a/configure.ng +++ b/configure.ng @@ -1,6 +1,6 @@ # # ngIRCd -- The Next Generation IRC Daemon -# Copyright (c)2001-2012 Alexander Barton (alex(a)barton.de) and Contributors +# Copyright (c)2001-2013 Alexander Barton (alex(a)barton.de) and Contributors # # 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 @@ -110,7 +110,7 @@ esac # Add additional CFLAGS, eventually specified on the command line: test -n "$CFLAGS_ADD" && CFLAGS="$CFLAGS $CFLAGS_ADD" -CFLAGS="$CFLAGS -DSYSCONFDIR='\"\$(sysconfdir)\"'" +CFLAGS="$CFLAGS -DSYSCONFDIR='\"\$(sysconfdir)\"' -DDOCDIR='\"\$(docdir)\"'" # -- Headers -- diff --git a/contrib/MacOSX/config.h b/contrib/MacOSX/config.h index 6da7496..f483827 100644 --- a/contrib/MacOSX/config.h +++ b/contrib/MacOSX/config.h @@ -1,6 +1,6 @@ /* * ngIRCd -- The Next Generation IRC Daemon - * Copyright (c)2001-2012 Alexander Barton (alex(a)barton.de) and Contributors. + * Copyright (c)2001-2013 Alexander Barton (alex(a)barton.de) and Contributors. * * 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 @@ -17,6 +17,7 @@ #define VERSION "??("__DATE__")" #endif #define SYSCONFDIR "/etc/ngircd" +#define DOCDIR "/usr/share/doc/ngircd" #ifndef TARGET_VENDOR #define TARGET_VENDOR "apple" diff --git a/doc/Makefile.am b/doc/Makefile.am index eb6fa93..04f74b6 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,6 +1,6 @@ # # ngIRCd -- The Next Generation IRC Daemon -# Copyright (c)2001-2012 Alexander Barton (alex(a)barton.de) and Contributors +# Copyright (c)2001-2013 Alexander Barton (alex(a)barton.de) and Contributors # # 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 @@ -12,6 +12,7 @@ .tmpl: $(AM_V_GEN)sed \ -e "s@:ETCDIR:@${sysconfdir}@" \ + -e "s@:DOCDIR:@${docdir}@" \ <$< >$@ SUFFIXES = .tmpl diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl index 3f80a9f..1c3998a 100644 --- a/doc/sample-ngircd.conf.tmpl +++ b/doc/sample-ngircd.conf.tmpl @@ -35,7 +35,7 @@ # Text file which contains the ngIRCd help text. This file is required # to display help texts when using the "HELP <cmd>" command. - ;HelpFile = :ETCDIR:/ngircd.help + ;HelpFile = :DOCDIR:/Commands.txt # Info text of the server. This will be shown by WHOIS and # LINKS requests for example. diff --git a/src/ngircd/conf.c b/src/ngircd/conf.c index fa1bfba..d5a28bd 100644 --- a/src/ngircd/conf.c +++ b/src/ngircd/conf.c @@ -1,6 +1,6 @@ /* * ngIRCd -- The Next Generation IRC Daemon - * Copyright (c)2001-2012 Alexander Barton (alex(a)barton.de) and Contributors. + * Copyright (c)2001-2013 Alexander Barton (alex(a)barton.de) and Contributors. * * 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 @@ -706,7 +706,7 @@ Set_Defaults(bool InitServers) array_free(&Conf_Helptext); strlcpy(Conf_MotdFile, SYSCONFDIR, sizeof(Conf_MotdFile)); strlcat(Conf_MotdFile, MOTD_FILE, sizeof(Conf_MotdFile)); - strlcpy(Conf_HelpFile, SYSCONFDIR, sizeof(Conf_HelpFile)); + strlcpy(Conf_HelpFile, DOCDIR, sizeof(Conf_HelpFile)); strlcat(Conf_HelpFile, HELP_FILE, sizeof(Conf_HelpFile)); strcpy(Conf_ServerPwd, ""); strlcpy(Conf_PidFile, PID_FILE, sizeof(Conf_PidFile)); diff --git a/src/ngircd/defines.h b/src/ngircd/defines.h index 28a260b..3850b58 100644 --- a/src/ngircd/defines.h +++ b/src/ngircd/defines.h @@ -78,7 +78,7 @@ #define MOTD_FILE "/ngircd.motd" /** Name of the help file. */ -#define HELP_FILE "/ngircd.help" +#define HELP_FILE "/Commands.txt" /** Default chroot() directory. */ #define CHROOT_DIR ""

1 0

Alexander Barton : Merge branch 'bug145-ProvideHelp'
by alex＠arthur.barton.de 02 Jan '13

02 Jan '13

Module: ngircd.git Branch: master Commit: 68cb1a8c2e507e7c99f787fab3540b904cfa1cc1 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=68cb1a8c… Author: Alexander Barton <alex(a)barton.de> Date: Wed Jan 2 23:41:46 2013 +0100 Merge branch 'bug145-ProvideHelp' * bug145-ProvideHelp: Use "${docdir}/Commands.txt" as help text file Add a note that "help file" is updated on startup and REHASH only Add doc/Commands.txt which should document all commands Implement Help() function parsing and returning the help text Document "HelpFile" in sample-ngircd.conf and ngircd.conf.5 Implement new configuration option "HelpFile" IRC_HELP(): Code cleanup Refactor Read_Motd() into Read_TextFile() ---

1 0

Alexander Barton : IRC_HELP(): Code cleanup
by alex＠arthur.barton.de 02 Jan '13

02 Jan '13

Module: ngircd.git Branch: master Commit: 588af510a35b5b28cb8c1063ac865f86c65d7a8a URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=588af510… Author: Alexander Barton <alex(a)barton.de> Date: Mon Dec 31 19:27:32 2012 +0100 IRC_HELP(): Code cleanup --- src/ngircd/irc.c | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/src/ngircd/irc.c b/src/ngircd/irc.c index 63c4813..1a0d725 100644 --- a/src/ngircd/irc.c +++ b/src/ngircd/irc.c @@ -304,25 +304,35 @@ IRC_TRACE( CLIENT *Client, REQUEST *Req ) } /* IRC_TRACE */ +/** + * Handler for the IRC "HELP" command. + * + * @param Client The client from which this command has been received. + * @param Req Request structure with prefix and all parameters. + * @return CONNECTED or DISCONNECTED. + */ GLOBAL bool -IRC_HELP( CLIENT *Client, REQUEST *Req ) +IRC_HELP(CLIENT *Client, REQUEST *Req) { COMMAND *cmd; - assert( Client != NULL ); - assert( Req != NULL ); + assert(Client != NULL); + assert(Req != NULL); /* Bad number of arguments? */ - if( Req->argc > 0 ) return IRC_WriteStrClient( Client, ERR_NORECIPIENT_MSG, Client_ID( Client ), Req->command ); + if (Req->argc > 0) + return IRC_WriteStrClient(Client, ERR_NORECIPIENT_MSG, + Client_ID(Client), Req->command); - cmd = Parse_GetCommandStruct( ); - while( cmd->name ) - { - if( ! IRC_WriteStrClient( Client, "NOTICE %s :%s", Client_ID( Client ), cmd->name )) return DISCONNECTED; + cmd = Parse_GetCommandStruct(); + while(cmd->name) { + if (!IRC_WriteStrClient(Client, "NOTICE %s :%s", + Client_ID(Client), cmd->name)) + return DISCONNECTED; cmd++; } - - IRC_SetPenalty( Client, 2 ); + + IRC_SetPenalty(Client, 2); return CONNECTED; } /* IRC_HELP */

1 0

Alexander Barton : Implement new configuration option "HelpFile"
by alex＠arthur.barton.de 02 Jan '13

02 Jan '13

Module: ngircd.git Branch: master Commit: f68aa02272d05ffbceea9e0188984d9bf9b83dd1 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=f68aa022… Author: Alexander Barton <alex(a)barton.de> Date: Mon Dec 31 19:29:52 2012 +0100 Implement new configuration option "HelpFile" This new configuration option allows to specify a specially formatted text file which can be used by the HELP command to provide information about the commands and their syntaxes. --- src/ngircd/conf.c | 17 +++++++++++++++++ src/ngircd/conf.h | 3 +++ src/ngircd/defines.h | 3 +++ 3 files changed, 23 insertions(+) diff --git a/src/ngircd/conf.c b/src/ngircd/conf.c index 423221c..fa1bfba 100644 --- a/src/ngircd/conf.c +++ b/src/ngircd/conf.c @@ -54,6 +54,7 @@ static CONF_SERVER New_Server; static int New_Server_Idx; static char Conf_MotdFile[FNAME_LEN]; +static char Conf_HelpFile[FNAME_LEN]; static void Set_Defaults PARAMS(( bool InitServers )); static bool Read_Config PARAMS(( bool TestOnly, bool IsStarting )); @@ -316,6 +317,7 @@ Conf_Test( void ) printf(" AdminInfo1 = %s\n", Conf_ServerAdmin1); printf(" AdminInfo2 = %s\n", Conf_ServerAdmin2); printf(" AdminEMail = %s\n", Conf_ServerAdminMail); + printf(" HelpFile = %s\n", Conf_HelpFile); printf(" Info = %s\n", Conf_ServerInfo); printf(" Listen = %s\n", Conf_ListenAddress); if (Using_MotdFile) { @@ -701,8 +703,11 @@ Set_Defaults(bool InitServers) Conf_ListenAddress = NULL; array_free(&Conf_ListenPorts); array_free(&Conf_Motd); + array_free(&Conf_Helptext); strlcpy(Conf_MotdFile, SYSCONFDIR, sizeof(Conf_MotdFile)); strlcat(Conf_MotdFile, MOTD_FILE, sizeof(Conf_MotdFile)); + strlcpy(Conf_HelpFile, SYSCONFDIR, sizeof(Conf_HelpFile)); + strlcat(Conf_HelpFile, HELP_FILE, sizeof(Conf_HelpFile)); strcpy(Conf_ServerPwd, ""); strlcpy(Conf_PidFile, PID_FILE, sizeof(Conf_PidFile)); Conf_UID = Conf_GID = 0; @@ -1047,6 +1052,12 @@ Read_Config(bool TestOnly, bool IsStarting) Using_MotdFile = true; } + /* Try to read ngIRCd help text file. */ + (void)Read_TextFile(Conf_HelpFile, "help text", &Conf_Helptext); + if (!array_bytes(&Conf_Helptext)) + Config_Error(LOG_WARNING, + "No help text available, HELP command will be of limited use."); + #ifdef SSL_SUPPORT /* Make sure that all SSL-related files are readable */ CheckFileReadable("CertFile", Conf_SSLOptions.CertFile); @@ -1312,6 +1323,12 @@ Handle_GLOBAL( int Line, char *Var, char *Arg ) Config_Error_TooLong(Line, Var); return; } + if (strcasecmp(Var, "HelpFile") == 0) { + len = strlcpy(Conf_HelpFile, Arg, sizeof(Conf_HelpFile)); + if (len >= sizeof(Conf_HelpFile)) + Config_Error_TooLong(Line, Var); + return; + } if (strcasecmp(Var, "Listen") == 0) { if (Conf_ListenAddress) { Config_Error(LOG_ERR, diff --git a/src/ngircd/conf.h b/src/ngircd/conf.h index f85a25f..ac42746 100644 --- a/src/ngircd/conf.h +++ b/src/ngircd/conf.h @@ -111,6 +111,9 @@ GLOBAL char Conf_ServerAdminMail[CLIENT_INFO_LEN]; /** Message of the day (MOTD) of this server */ GLOBAL array Conf_Motd; +/** Help text of this server */ +GLOBAL array Conf_Helptext; + /** Array of ports this server should listen on */ GLOBAL array Conf_ListenPorts; diff --git a/src/ngircd/defines.h b/src/ngircd/defines.h index ad9716f..28a260b 100644 --- a/src/ngircd/defines.h +++ b/src/ngircd/defines.h @@ -77,6 +77,9 @@ /** Name of the MOTD file. */ #define MOTD_FILE "/ngircd.motd" +/** Name of the help file. */ +#define HELP_FILE "/ngircd.help" + /** Default chroot() directory. */ #define CHROOT_DIR ""

1 0

Alexander Barton : Document "HelpFile" in sample-ngircd.conf and ngircd. conf.5
by alex＠arthur.barton.de 02 Jan '13

02 Jan '13

Module: ngircd.git Branch: master Commit: d2a1f6aa4be7e42dd76e5342b309b8331d86bab4 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=d2a1f6aa… Author: Alexander Barton <alex(a)barton.de> Date: Mon Dec 31 21:03:23 2012 +0100 Document "HelpFile" in sample-ngircd.conf and ngircd.conf.5 --- doc/sample-ngircd.conf.tmpl | 4 ++++ man/ngircd.conf.5.tmpl | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl index 997a983..3f80a9f 100644 --- a/doc/sample-ngircd.conf.tmpl +++ b/doc/sample-ngircd.conf.tmpl @@ -33,6 +33,10 @@ ;AdminInfo2 = Location ;AdminEMail = admin(a)irc.server + # Text file which contains the ngIRCd help text. This file is required + # to display help texts when using the "HELP <cmd>" command. + ;HelpFile = :ETCDIR:/ngircd.help + # Info text of the server. This will be shown by WHOIS and # LINKS requests for example. Info = Server Info Text diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl index e3f62c8..681e86c 100644 --- a/man/ngircd.conf.5.tmpl +++ b/man/ngircd.conf.5.tmpl @@ -101,6 +101,10 @@ IRC network and must contain at least one dot (".") character. Information about the server and the administrator, used by the ADMIN command. This information is not required by the server but by RFC! .TP +\fBHelpFile\fR (string) +Text file which contains the ngIRCd help text. This file is required +to display help texts when using the "HELP <cmd>" command. +.TP \fBInfo\fR (string) Info text of the server. This will be shown by WHOIS and LINKS requests for example.

1 0

Alexander Barton : Implement Help() function parsing and returning the help text
by alex＠arthur.barton.de 02 Jan '13

02 Jan '13

Module: ngircd.git Branch: master Commit: 289a26e9e43be303a7355ab530ddcaa84aca60b9 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=289a26e9… Author: Alexander Barton <alex(a)barton.de> Date: Tue Jan 1 14:57:03 2013 +0100 Implement Help() function parsing and returning the help text This function parses the already read in help text and sends the requested portions to the user. Parsing is done as following when a user user issues a "HELP <cmd>" command: 1. Search the file for a line "- <cmd>", 2. Output all subsequent lines that start with a TAB (ASCII 9) character to the client using NOTICE commands, treat lines containing a single "." after the TAB as empty lines. 3. Break at the first line not starting with a TAB character. This format allows to have information to each command stored in this file which will not be sent to an IRC user requesting help which enables us to have additional annotations stored here which further describe the origin, implementation details, or limits of the specific command. A special "Intro" block is returned to the user when the HELP command is used without a command name. --- src/ngircd/irc.c | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 81 insertions(+), 3 deletions(-) diff --git a/src/ngircd/irc.c b/src/ngircd/irc.c index 1a0d725..f6b9dc5 100644 --- a/src/ngircd/irc.c +++ b/src/ngircd/irc.c @@ -44,6 +44,7 @@ static bool Send_Message PARAMS((CLIENT *Client, REQUEST *Req, int ForceType, static bool Send_Message_Mask PARAMS((CLIENT *from, char *command, char *targetMask, char *message, bool SendErrors)); +static bool Help PARAMS((CLIENT *Client, const char *Topic)); /** @@ -320,10 +321,23 @@ IRC_HELP(CLIENT *Client, REQUEST *Req) assert(Req != NULL); /* Bad number of arguments? */ - if (Req->argc > 0) + if (Req->argc > 1) return IRC_WriteStrClient(Client, ERR_NORECIPIENT_MSG, Client_ID(Client), Req->command); + IRC_SetPenalty(Client, 2); + + if ((Req->argc == 0 && array_bytes(&Conf_Helptext) > 0) + || (Req->argc >= 1 && strcasecmp(Req->argv[0], "Commands") != 0)) { + /* Help text available and requested */ + if (Req->argc >= 1) + return Help(Client, Req->argv[0]); + + if (!Help(Client, "Intro")) + return DISCONNECTED; + return CONNECTED; + } + cmd = Parse_GetCommandStruct(); while(cmd->name) { if (!IRC_WriteStrClient(Client, "NOTICE %s :%s", @@ -331,12 +345,76 @@ IRC_HELP(CLIENT *Client, REQUEST *Req) return DISCONNECTED; cmd++; } - - IRC_SetPenalty(Client, 2); return CONNECTED; } /* IRC_HELP */ +/** + * Send help for a given topic to the client. + * + * @param Client The client requesting help. + * @param Topoc The help topic requested. + * @return CONNECTED or DISCONNECTED. + */ +static bool +Help(CLIENT *Client, const char *Topic) +{ + char *line; + size_t helptext_len, len_str, idx_start, lines = 0; + bool in_article = false; + + assert(Client != NULL); + assert(Topic != NULL); + + helptext_len = array_bytes(&Conf_Helptext); + line = array_start(&Conf_Helptext); + while (helptext_len > 0) { + len_str = strlen(line) + 1; + assert(helptext_len >= len_str); + helptext_len -= len_str; + + if (in_article) { + /* The first character in each article text line must + * be a TAB (ASCII 9) character which will be stripped + * in the output. If it is not a TAB, the end of the + * article has been reached. */ + if (line[0] != '\t') { + if (lines > 0) + return CONNECTED; + else + break; + } + + /* A single '.' character indicates an empty line */ + if (line[1] == '.' && line[2] == '\0') + idx_start = 2; + else + idx_start = 1; + + if (!IRC_WriteStrClient(Client, "NOTICE %s :%s", + Client_ID(Client), + &line[idx_start])) + return DISCONNECTED; + lines++; + + } else { + if (line[0] == '-' && line[1] == ' ' + && strcasecmp(&line[2], Topic) == 0) + in_article = true; + } + + line += len_str; + } + + /* Help topic not found (or empty)! */ + if (!IRC_WriteStrClient(Client, "NOTICE %s :No help for \"%s\" found!", + Client_ID(Client), Topic)) + return DISCONNECTED; + + return CONNECTED; +} + + static char * #ifdef ZLIB Option_String(CONN_ID Idx)

1 0

Alexander Barton : Add doc/Commands.txt which should document all commands
by alex＠arthur.barton.de 02 Jan '13

02 Jan '13

Module: ngircd.git Branch: master Commit: 8ec09e3ca47a8d2ca0502831d77f7edc8c4749a6 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=8ec09e3c… Author: Alexander Barton <alex(a)barton.de> Date: Tue Jan 1 15:09:09 2013 +0100 Add doc/Commands.txt which should document all commands This document can be used as "help text", too, see configuration option "HelpFile" in ngircd.conf(5). Please note that this file in its current state is far from complete, only a few commands are documented, but you should get an idea how it works. So please send in patches adding the remaining parts! :-) --- doc/Commands.txt | 219 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/Makefile.am | 1 + 2 files changed, 220 insertions(+) diff --git a/doc/Commands.txt b/doc/Commands.txt new file mode 100644 index 0000000..e9b7873 --- /dev/null +++ b/doc/Commands.txt @@ -0,0 +1,219 @@ + + ngIRCd - Next Generation IRC Server + http://ngircd.barton.de/ + + (c)2001-2013 Alexander Barton and Contributors. + ngIRCd is free software and published under the + terms of the GNU General Public License. + + -- Commands.txt -- + + +This file lists all commands available on ngIRCd. It is written in a format +that is human readable as well as machine parseable and therefore can be used +as "help text file" of the daemon. + +In short, the HELP command parses this file as following when a user user +issues a "HELP <cmd>" command: + + 1. Search the file for a line "- <cmd>", + 2. Output all subsequent lines that start with a TAB (ASCII 9) character + to the client using NOTICE commands, treat lines containing a single "." + after the TAB as empty lines. + 3. Break at the first line not starting with a TAB character. + +This format allows to have information to each command stored in this file +which will not be sent to an IRC user requesting help which enables us to +have additional annotations stored here which further describe the origin, +implementation details, or limits of the specific command. + +A special "Intro" block is returned to the user when the HELP command is +used without a command name: + + +- Intro + This is ngIRCd, a server software for Internet Relay Chat (IRC) + networks. You can find more information about ngIRCd on its homepage: + <http://ngircd.barton.de> + . + Use "HELP COMMANDS" to get a list of all available commands and + "HELP <command-name>" to get help for a specific IRC command, for + example "HELP quit" or "HELP privmsg". + + +General Commands +~~~~~~~~~~~~~~~~ + +- AWAY + +- CAP + +- CHARCONV + +- HELP + HELP [<command>] + . + Show help information for a specific IRC <command>. The <command> name + is case-insensitive. + . + Use the command "HELP Commands" to get a list of all available commands. + + The HELP command isn't specified by any RFC but implemented by most + daemons. If no help text could be read in, ngIRCd outputs a list of all + implemented commands when receiving a plain "HELP" command as well as + on "HELP Commands". + + ngIRCd replies using "NOTICE" commands like ircd 2.10/2.11; other + implementations are using numerics 704, 705, and 706. + + +- MODE + +- NICK + +- NOTICE + +- PASS + +- PING + +- PONG + +- PRIVMSG + +- QUIT + QUIT [<quit-message>] + . + End IRC session and disconnect from the server. + . + If a <quit-message> has been given, it is displayed to all the + channels that you are a member of when leaving. + +- USER + +- WALLOPS + +- WEBIRC + + +Status and Informational Commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- INFO + +- ISON + +- LINKS + +- LUSERS + +- METADATA + +- MOTD + +- NAMES + +- STATS + +- TIME + +- TRACE + +- USERHOST + +- VERSION + +- WHO + +- WHOIS + +- WHOWAS + + +Channel Commands +~~~~~~~~~~~~~~~~ + +- INVITE + +- JOIN + +- KICK + +- LIST + +- PART + +- TOPIC + + +Administrative Commands +~~~~~~~~~~~~~~~~~~~~~~~ + +- ADMIN + ADMIN [<server>] + . + Show administartive information about an IRC server in the network. + If no server name has been given, the local server will respond. + +- CONNECT + +- DIE + +- DISCONNECT + +- GLINE + +- KILL + +- KLINE + +- OPER + +- REHASH + +- RESTART + + +IRC Service Commands +~~~~~~~~~~~~~~~~~~~~~~~~ + +- SERVICE + +- SERVLIST + +- SQUERY + +- SVSNICK + + +Server Protocol Commands +~~~~~~~~~~~~~~~~~~~~~~~~ + +- CHANINFO + +- ERROR + ERROR [<message> [<> [...]]] + . + Return an error message to the server. The first parameter, if given, + will be logged by the server, all further parameters are silently + ignored. + . + This command is silently ignored on non-server and non-service links. + +- NJOIN + +- SERVER + +- SQUIT + + +Dummy Commands +~~~~~~~~~~~~~~ + +- SUMMON + +- USERS + +- GET + +- POST diff --git a/doc/Makefile.am b/doc/Makefile.am index 2b9b3aa..eb6fa93 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -19,6 +19,7 @@ SUFFIXES = .tmpl static_docs = \ Bopm.txt \ Capabilities.txt \ + Commands.txt \ Contributing.txt \ FAQ.txt \ GIT.txt \

1 0