noffle: src/protocol.h annotate

annotate src/protocol.h @ 500:614a3177b15c noffle tip

Add mail-from option. Some modern mail systems will try and ensure the sender email is a legitimate address. Which will fail if there isn't such an address.

author	Jim Hague <jim.hague@acm.org>
date	Wed, 14 Aug 2013 12:04:39 +0100
parents	baa6408d1bbc
children

rev	line source
43 2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	1 /*
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	2 protocol.h
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	3
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	4 Functions related with the NNTP protocol which are useful for both
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	5 the server and the client.
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	6
282 baa6408d1bbc [svn] * src/database.c,src/post.c,src/protocol.h,src/protocol.c: When posting, bears parents: 281 diff changeset	7 $Id: protocol.h 414 2003-01-06 18:16:18Z bears $
43 2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	8 */
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	9
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	10 #ifndef PRT_H
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	11 #define PRT_H
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	12
45 32ba1198c6fa [svn] * Makefile.in, configure, configure.in, docs/Makefile.in, src/Makefile.in: uh1763 parents: 43 diff changeset	13 #if HAVE_CONFIG_H
32ba1198c6fa [svn] * Makefile.in, configure, configure.in, docs/Makefile.in, src/Makefile.in: uh1763 parents: 43 diff changeset	14 #include <config.h>
32ba1198c6fa [svn] * Makefile.in, configure, configure.in, docs/Makefile.in, src/Makefile.in: uh1763 parents: 43 diff changeset	15 #endif
32ba1198c6fa [svn] * Makefile.in, configure, configure.in, docs/Makefile.in, src/Makefile.in: uh1763 parents: 43 diff changeset	16
43 2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	17 #include "dynamicstring.h"
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	18 #include "over.h"
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	19
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	20 #define STAT_HELP_FOLLOWS 100
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	21 #define STAT_DEBUG_FOLLOWS 199
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	22
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	23 #define STAT_READY_POST_ALLOW 200
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	24 #define STAT_READY_NO_POST_ALLOW 201
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	25 #define STAT_CMD_OK 202
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	26 #define STAT_GOODBYE 205
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	27 #define STAT_GRP_SELECTED 211
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	28 #define STAT_GRPS_FOLLOW 215
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	29 #define STAT_ART_FOLLOWS 220
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	30 #define STAT_HEAD_FOLLOWS 221
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	31 #define STAT_BODY_FOLLOWS 222
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	32 #define STAT_ART_RETRIEVED 223
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	33 #define STAT_OVERS_FOLLOW 224
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	34 #define STAT_NEW_GRP_FOLLOW 231
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	35 #define STAT_POST_OK 240
281 5eece4dfd945 [svn] * src/log.c,src/log.h: Add Log_fatal() for reporting fatal errors bears parents: 197 diff changeset	36 #define STAT_AUTH_ACCEPTED 281
43 2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	37
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	38 #define STAT_SEND_ART 340
281 5eece4dfd945 [svn] * src/log.c,src/log.h: Add Log_fatal() for reporting fatal errors bears parents: 197 diff changeset	39 #define STAT_MORE_AUTH_REQUIRED 381
43 2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	40
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	41 #define STAT_NO_SUCH_GRP 411
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	42 #define STAT_NO_GRP_SELECTED 412
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	43 #define STAT_NO_ART_SELECTED 420
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	44 #define STAT_NO_NEXT_ART 421
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	45 #define STAT_NO_PREV_ART 422
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	46 #define STAT_NO_SUCH_NUMB 423
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	47 #define STAT_NO_SUCH_ID 430
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	48 #define STAT_ART_REJECTED 437
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	49 #define STAT_POST_FAILED 441
281 5eece4dfd945 [svn] * src/log.c,src/log.h: Add Log_fatal() for reporting fatal errors bears parents: 197 diff changeset	50 #define STAT_AUTH_REQUIRED 480
5eece4dfd945 [svn] * src/log.c,src/log.h: Add Log_fatal() for reporting fatal errors bears parents: 197 diff changeset	51 #define STAT_AUTH_REJECTED 482
43 2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	52
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	53 #define STAT_NO_SUCH_CMD 500
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	54 #define STAT_SYNTAX_ERR 501
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	55 #define STAT_NO_PERMISSION 502
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	56 #define STAT_PROGRAM_FAULT 503
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	57
281 5eece4dfd945 [svn] * src/log.c,src/log.h: Add Log_fatal() for reporting fatal errors bears parents: 197 diff changeset	58 /* Statuses from AUTHINFO SIMPLE - deprecated */
5eece4dfd945 [svn] * src/log.c,src/log.h: Add Log_fatal() for reporting fatal errors bears parents: 197 diff changeset	59 #define STAT_AUTH_ACCEPTED_DEPREC 250
5eece4dfd945 [svn] * src/log.c,src/log.h: Add Log_fatal() for reporting fatal errors bears parents: 197 diff changeset	60 #define STAT_AUTH_REQUIRED_DEPREC 450
5eece4dfd945 [svn] * src/log.c,src/log.h: Add Log_fatal() for reporting fatal errors bears parents: 197 diff changeset	61 #define STAT_AUTH_REJECTED_DEPREC 452
5eece4dfd945 [svn] * src/log.c,src/log.h: Add Log_fatal() for reporting fatal errors bears parents: 197 diff changeset	62 #define STAT_MORE_AUTH_REQUIRED_DEPREC 350
5eece4dfd945 [svn] * src/log.c,src/log.h: Add Log_fatal() for reporting fatal errors bears parents: 197 diff changeset	63
43 2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	64 /*
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	65 Read next line from f into Str, up to "\n" or "\r\n". Don't save "\n"
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	66 or "\r\n" in line. Terminate with '\0'.
144 8b9366fc1361 [svn] Added timeout to Prt_getLn to avoid Noffle hanging if the enz parents: 111 diff changeset	67 If timeoutSeconds < 0, no timeout alarm is used.
43 2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	68 */
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	69 Bool
144 8b9366fc1361 [svn] Added timeout to Prt_getLn to avoid Noffle hanging if the enz parents: 111 diff changeset	70 Prt_getLn( Str line, FILE *f, int timeoutSeconds );
43 2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	71
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	72 /*
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	73 Read a text line from server. Returns TRUE if line != ".", removes
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	74 leading '.' otherwise.
197 24d4cd032da5 [svn] * AUTHORS,INSTALL,NEWS,README,TODO,docs/NOTES,src/client.c,src/protocol.c, bears parents: 187 diff changeset	75 If timeoutSeconds < 0, no timeout alarm is used.
43 2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	76 */
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	77 Bool
144 8b9366fc1361 [svn] Added timeout to Prt_getLn to avoid Noffle hanging if the enz parents: 111 diff changeset	78 Prt_getTxtLn( Str line, Bool err, FILE f, int timeoutSeconds );
43 2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	79
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	80 /*
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	81 Write text line to f. Escape "." at the beginning with another ".".
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	82 Terminate with "\r\n".
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	83 */
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	84 Bool
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	85 Prt_putTxtLn( const char* line, FILE *f );
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	86
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	87 /*
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	88 Write text buffer of lines each ending with '\n'.
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	89 Replace '\n' by "\r\n".
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	90 */
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	91 Bool
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	92 Prt_putTxtBuf( const char buf, FILE f );
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	93
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	94 /*
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	95 Write text-ending "."-line to f
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	96 */
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	97 Bool
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	98 Prt_putEndOfTxt( FILE *f );
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	99
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	100 /*
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	101 Splits line in field and value. Field is converted to lower-case.
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	102 */
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	103 Bool
282 baa6408d1bbc [svn] * src/database.c,src/post.c,src/protocol.h,src/protocol.c: When posting, bears parents: 281 diff changeset	104 Prt_getField( Str resultField, Str resultValue,
baa6408d1bbc [svn] * src/database.c,src/post.c,src/protocol.h,src/protocol.c: When posting, bears parents: 281 diff changeset	105 Bool* isContinuation, const char* line );
43 2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	106
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	107 /* Search header. Works only with single line headers (ignores continuation
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	108 lines */
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	109 Bool
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	110 Prt_searchHeader( const char artTxt, const char which, Str result );
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	111
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	112 Bool
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	113 Prt_isValidMsgId( const char *msgId );
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	114
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	115 void
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	116 Prt_genMsgId( Str msgId, const char from, const char suffix );
2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	117
111 6f681d41734c [svn] path-header added. bears parents: 45 diff changeset	118 void
6f681d41734c [svn] path-header added. bears parents: 45 diff changeset	119 Prt_genPathHdr( Str pathHdr, const char *from );
6f681d41734c [svn] path-header added. bears parents: 45 diff changeset	120
150 1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line bears parents: 144 diff changeset	121 Bool
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line bears parents: 144 diff changeset	122 Prt_genFromHdr( Str fromHdr );
1c7303c71f66 [svn] * src/protocol.c: Fix bug in Prt_getLn if we should read a line bears parents: 144 diff changeset	123
43 2842f50feb55 [svn] * client.c, client.h, common.h, config.c, config.h, content.c, content.h, uh1763 parents: diff changeset	124 #endif

Mercurial > noffle

annotate src/protocol.h @ 500:614a3177b15c noffle tip