"Fossies" - the Fresh Open Source Software Archive 
Member "tin-2.4.3/include/nntplib.h" (23 Nov 2018, 8932 Bytes) of package /linux/misc/tin-2.4.3.tar.xz:
As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) C and C++ source code syntax highlighting (style:
standard) with prefixed line numbers and
code folding option.
Alternatively you can here
view or
download the uninterpreted source code file.
For more information about "nntplib.h" see the
Fossies "Dox" file reference documentation and the latest
Fossies "Diffs" side-by-side code changes report:
2.4.2_vs_2.4.3.
1 /*
2 * Project : tin - a Usenet reader
3 * Module : nntplib.h
4 * Author : I.Lea
5 * Created : 1991-04-01
6 * Updated : 2018-02-10
7 * Notes : nntp.h 1.5.11/1.6 with extensions for tin
8 *
9 * Copyright (c) 1991-2019 Iain Lea <iain@bricbrac.de>
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 4. The name of the author may not be used to endorse or promote
21 * products derived from this software without specific prior written
22 * permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
25 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
26 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
28 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
30 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
32 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
33 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
34 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 */
36
37
38 #ifndef NNTPLIB_H
39 #define NNTPLIB_H 1
40
41 #ifndef NNTP_SERVER_FILE
42 # define NNTP_SERVER_FILE "/etc/nntpserver"
43 #endif /* !NNTP_SERVER_FILE */
44
45 #define NNTP_TCP_NAME "nntp"
46 #define NNTP_TCP_PORT "119"
47
48 /*
49 * # times to try and reconnect to server after timeout
50 */
51 #define NNTP_TRY_RECONNECT 2
52
53 /*
54 * @(#)Header: nntp.h,v 1.81 92/03/12 02:08:31 sob Exp $
55 *
56 * First digit:
57 *
58 * 1xx Informative message
59 * 2xx Command ok
60 * 3xx Command ok so far, continue
61 * 4xx Command was correct, but couldn't be performed
62 * for some specified reason.
63 * 5xx Command unimplemented, incorrect, or a
64 * program error has occurred.
65 *
66 * Second digit:
67 *
68 * x0x Connection, setup, miscellaneous
69 * x1x Newsgroup selection
70 * x2x Article selection
71 * x3x Distribution
72 * x4x Posting
73 */
74 #if 0 /* unused */
75 # define CHAR_INF '1'
76 # define CHAR_OK '2'
77 # define CHAR_CONT '3'
78 # define CHAR_ERR '4'
79 # define CHAR_FATAL '5'
80 #endif /* 0 */
81
82 /* TODO: cleanup against RFC 2980, RFC 3977, RFC 4643, RFC 6048, RFC 8054 */
83 #define INF_HELP 100 /* Help text on way */
84 #define INF_CAPABILITIES 101 /* Capability list follows */
85 #define INF_DATE 111 /* yyyymmddhhmmss Server date and time */
86
87 #define OK_CANPOST 200 /* Hello; you can post */
88 #define OK_NOPOST 201 /* Hello; you can't post */
89 #define OK_EXTENSIONS 202 /* extensions supported follow */
90 #define OK_GOODBYE 205 /* Closing connection */
91 #define OK_COMPRESS 206 /* Compression active */
92 #define OK_GROUP 211 /* Group selected */
93 #define OK_GROUPS 215 /* Newsgroups follow */
94 #define OK_MOTD 215 /* News motd follows */
95
96 #define OK_ARTICLE 220 /* Article (head & body) follows */
97 #define OK_HEAD 221 /* Head follows */
98 #define OK_XHDR 221 /* headers follow */
99 #define OK_XPAT 221 /* headers follow */
100 #define OK_BODY 222 /* Body follows */
101 #define OK_NOTEXT 223 /* No text sent -- stat, next, last */
102 #define OK_XOVER 224 /* .overview data follows */
103 #define OK_HDR 225 /* headers follow */
104 #define OK_NEWNEWS 230 /* New articles by message-id follow */
105 #define OK_NEWGROUPS 231 /* New newsgroups follow */
106 #define OK_XFERED 235 /* Article transferred successfully */
107 #define OK_POSTED 240 /* Article posted successfully */
108 #define OK_AUTHSYS 280 /* Authorization system ok */
109 #define OK_AUTH 281 /* Authorization (user/pass) ok */
110 #define OK_BIN 282 /* binary data follows */
111 #define OK_LIST 282 /* list follows */
112 #define OK_AUTH_SASL 283 /* authentication accepted (with success data) */
113
114 #define CONT_XFER 335 /* Continue to send article */
115 #define CONT_POST 340 /* Continue to post article */
116 #define NEED_AUTHINFO 380 /* authorization is required */
117 #define NEED_AUTHDATA 381 /* <type> authorization data required */
118 #define NEED_AUTHDATA_SASL 383 /* continue with SASL exchange */
119
120 #define ERR_GOODBYE 400 /* Have to hang up for some reason */
121 #define ERR_STATE 401 /* The client must change the state of the connection */
122 #define ERR_COMPRESS 403 /* Unable to activate compression */
123 #define ERR_NOGROUP 411 /* No such newsgroup */
124 #define ERR_NCING 412 /* Not currently in newsgroup */
125
126 #define ERR_NOCRNT 420 /* No current article selected */
127 #define ERR_NONEXT 421 /* No next article in this group */
128 #define ERR_NOPREV 422 /* No previous article in this group */
129 #define ERR_NOARTIG 423 /* No such article in this group */
130 #define ERR_NOART 430 /* No such article at all */
131 #define ERR_GOTIT 435 /* Already got that article, don't send */
132 #define ERR_XFERFAIL 436 /* Transfer failed */
133 #define ERR_XFERRJCT 437 /* Article rejected, don't resend */
134 #define ERR_NOPOST 440 /* Posting not allowed */
135 #define ERR_POSTFAIL 441 /* Posting failed */
136 #define ERR_NOAUTH 480 /* authorization required for command */
137 #define ERR_AUTHFAIL 481 /* Authentication failed/rejected */
138 #define ERR_AUTHSEQ 482 /* Authentication commands issued out of sequence or SASL protocol error */
139 #define ERR_ENCRYPT 483 /* encrpytion required */
140
141 #define ERR_COMMAND 500 /* Command not recognized */
142 #define ERR_CMDSYN 501 /* Command syntax error */
143 #define ERR_ACCESS 502 /* Access to server denied */
144 #define ERR_FAULT 503 /* Program fault, command not performed */
145 #define ERR_MOTD 503 /* No news motd file */
146 #define ERR_COMPRESS_ALG 503 /* Compression algorithm not supported */
147 #define ERR_AUTHBAD 580 /* Authorization Failed */
148
149 /*
150 * RFC 977 defines this; don't change it.
151 */
152 #define NNTP_STRLEN 512
153 /*
154 * RFC 3977 3.1
155 */
156 #define NNTP_GRPLEN 497
157
158 /*
159 * OVERVIEW.FMT field types
160 */
161 enum f_type { OVER_T_ERROR, OVER_T_INT, OVER_T_STRING, OVER_T_FSTRING };
162
163 /*
164 * CAPABILITIES
165 * remember to update init.c and nntplib.c:check_extensions() if you change
166 * t_capabilities
167 */
168 enum extension_type { NONE, CAPABILITIES, BROKEN };
169
170 enum sasl_types {
171 SASL_NONE = 0,
172 SASL_PLAIN = 1 << 0,
173 SASL_CRAM_MD5 = 1 << 1,
174 SASL_DIGEST_MD5 = 1 << 2,
175 SASL_GSSAPI = 1 << 3,
176 SASL_EXTERNAL = 1 << 4,
177 SASL_OTP = 1 << 5,
178 SASL_NTLM = 1 << 6,
179 SASL_LOGIN = 1 << 7
180 };
181 enum c_algorithms { COMPRESS_NONE, COMPRESS_DEFLATE };
182
183 struct t_capabilities {
184 enum extension_type type; /* NONE, CAPABILITIES, BROKEN */
185 unsigned int version; /* CAPABILITIES version */
186 t_bool mode_reader:1; /* MODE-READER: "MODE READER" */
187 t_bool reader:1; /* READER: "ARTICLE", "BODY", "DATE", "GROUP", "LAST", "LISTGROUP", "NEWGROUPS", "NEXT" */
188 t_bool post:1; /* POST */
189 t_bool list_active:1; /* LIST ACTIVE */
190 t_bool list_active_times:1; /* LIST ACTIVE.TIMES, optional */
191 t_bool list_distrib_pats:1; /* LIST DISTRIB.PATS, optional */
192 t_bool list_headers:1; /* LIST HEADERS */
193 char *headers_range; /* list of headers by range */
194 char *headers_id; /* list of headers by id */
195 t_bool list_newsgroups:1; /* LIST NEWSGROUPS */
196 t_bool list_overview_fmt:1; /* LIST OVERVIEW.FMT */
197 t_bool list_motd:1; /* LIST MOTD, "private" extension */
198 t_bool list_subscriptions:1; /* LIST SUBSCRIPTIONS, "private" extension, RFC 2980 */
199 t_bool list_distributions:1; /* LIST DISTRIBUTIONS, "private" extension, RFC 2980 */
200 t_bool list_moderators:1; /* LIST MODERATORS, "private" extension */
201 t_bool list_counts:1; /* LIST COUNTS, "private" extension */
202 t_bool xpat:1; /* XPAT, "private" extension, RFC 2980 */
203 t_bool hdr:1; /* HDR: "HDR", "LIST HEADERS" */
204 const char *hdr_cmd; /* [X]HDR */
205 t_bool over:1; /* OVER: "OVER", "LIST OVERVIEW.FMT" */
206 t_bool over_msgid:1; /* OVER: "OVER mid" */
207 const char *over_cmd; /* [X]OVER */
208 t_bool newnews:1; /* NEWNEWS */
209 char *implementation; /* IMPLEMENTATION */
210 t_bool starttls:1; /* STARTTLS */
211 t_bool authinfo_user:1; /* AUTHINFO USER/PASS */
212 t_bool authinfo_sasl:1; /* AUTHINFO SASL */
213 t_bool authinfo_state:1; /* AUTHINFO not supported in current state */
214 enum sasl_types sasl; /* SASL_NONE, SASL_PLAIN, SASL_CRAM_MD5, SASL_DIGEST_MD5, SASL_GSSAPI, SASL_EXTERNAL, SASL_OTP, SASL_NTLM, SASL_LOGIN */
215 t_bool compress:1; /* COMPRESS */
216 enum c_algorithms compress_algorithm; /* COMPRESS_NONE, COMPRESS_DEFLATE */
217 #if 0
218 t_bool streaming:1; /* STREAMING: "MODE STREAM", "CHECK", "TAKETHIS" */
219 t_bool ihave:1; /* IHAVE: "IHAVE" */
220 #endif /* 0 */
221 t_bool broken_listgroup:1; /* LISTGROUP doesn't select newsgroup */
222 };
223
224 #endif /* !NNTPLIB_H */