1 // Copyright 2000-2005 the Contributors, as shown in the revision logs.
2 // Licensed under the Apache Public Source License 2.0 ("the License").
3 // You may not use this file except in compliance with the License.
7 // 503 optional subfeature not supported
9 // LIST EXTENSIONS is probably incomplete
11 package org.ibex.mail.protocol;
12 import org.ibex.util.*;
14 import org.ibex.mail.*;
15 import org.ibex.mail.target.*;
16 import org.ibex.jinetd.*;
22 /** NNTP send/recieve */
25 public static final DateFormat dateFormat = new SimpleDateFormat("yyyyMMDDhhmmss");
27 public static class No extends RuntimeException { int code = 400; } // 4xx response codes
28 public static class Bad extends RuntimeException { int code = 500; public Bad(String s) { super(s); } } // 5xx response codes
30 public static class Group {
31 public Group(String n, boolean p, int f, int l, int c) { this.name=n;this.post=p;this.first=f;this.last=l;this.count=c;}
32 public final String name; // case insensitive
33 public final boolean post;
34 public final int first;
35 public final int last;
36 public final int count; // an approximation; must be >= actual number
39 public static class Article {
40 public Article(int num, Message message) { this.message = message; this.num = num;}
42 public final Message message;
45 public static interface Server {
46 public Group group(String s);
47 public boolean ihave(String messageid);
48 public Article next();
49 public Article last();
50 public boolean postok();
51 public void post(Message m) throws IOException;
52 public Article article(String messageid, boolean head, boolean body);
53 public Article article(int messagenum, boolean head, boolean body);
54 public Group[] list();
55 public Group[] newgroups(Date d, String[] distributions);
56 public String[] newnews(String[] groups, Date d, String[] distributions);
59 public static class MailboxWrapper implements Server {
60 private final Mailbox root;
61 private Mailbox current;
64 public MailboxWrapper(Mailbox root) { this(root, false); }
65 public MailboxWrapper(Mailbox root, boolean post) { this.root = root; this.post = post; }
66 public boolean postok() { return post; }
67 public void post(Message m) throws IOException { current.accept(m); }
68 public Group group(String s) {
70 Group g = getgroup(s);
71 if (g==null) return null;
76 public boolean ihave(String messageid) { /* FEATURE */ return false; }
78 public Article next() { return article(ptr++, false, false); }
79 public Article last() { return article(ptr--, false, false); }
80 public Article article(String i, boolean h, boolean b) { return article(Query.header("message-id",i),h,b); }
81 public Article article(int n, boolean h, boolean b) { ptr = n; return article(Query.messagenum(n,n),h,b); }
82 private Article article(Query q, boolean head, boolean body) {
83 Mailbox.Iterator it = current.iterator(q);
84 if (!it.next()) return null;
86 Message m = body ? it.cur() : Message.newMessage(new Fountain.StringFountain(it.head() + "\r\n"));
87 return new Article(it.num(), m);
88 } catch (Exception e) { return null; }
90 public Group[] list() { return list(root, ""); }
91 private Group[] list(Mailbox who, String prefix) {
93 if (who == null) who = root;
94 String[] s = who.children();
95 for(int i=0; i<s.length; i++) {
96 v.addElement(new Group(prefix + s[i], true, 0, 0, 0)); // FIXME numbers
97 Group[] g2 = list(who.slash(s[i], false), prefix + s[i] + ".");
98 for(int j=0; j<g2.length; j++) v.addElement(g2[j]);
100 Group[] ret = new Group[v.size()];
105 private void setgroup(String s) {
106 Mailbox ncurrent = root;
107 for(StringTokenizer st = new StringTokenizer(s, ".");
108 ncurrent != null && st.hasMoreTokens();
109 ncurrent = ncurrent.slash(st.nextToken(), false));
110 if (ncurrent!=null) current=ncurrent;
112 private Group getgroup(String s) {
114 Log.error("", "getgroup " + s);
115 Log.error("", "mailbox " + root);
116 for(StringTokenizer st = new StringTokenizer(s, "."); box!=null && st.hasMoreTokens(); box = box.slash(st.nextToken(), false));
117 if (box==null) return null;
118 return new Group(s, true, 1, box.count(Query.all()), box.count(Query.all()));
121 public Group[] newgroups(Date d, String[] distributions) { /* FEATURE */ return new Group[] { }; }
122 public String[] newnews(String[] groups, Date d, String[] distributions) { /* FIXME */ return null; }
125 public static class Listener {
126 private Server api = null;
128 private Connection conn;
129 public Listener(Login l) { this.login = l; }
131 private void println(String s) { Log.warn("[nntp-write]", s); conn.println(s); }
132 private void println() { Log.warn("[nntp-write]", ""); conn.println(""); }
133 private void print(String s) { Log.warn("[nntp-write]", s); conn.print(s); }
135 private void article(String numOrMessageId, boolean head, boolean body) {
136 String s = numOrMessageId.trim();
138 if (s.startsWith("<")) a = api.article(s.substring(0, s.length() - 1), head, body);
139 else a = api.article(Integer.parseInt(s), head, body);
141 println("423 No such article.");
144 int code = (head && body) ? 220 : head ? 221 : body ? 222 : 223;
145 println(code + " " + a.num + " <" + a.message.messageid + "> get ready for some stuff...");
146 if (head) println(a.message.headers.getString());
147 if (head && body) println();
149 Stream stream = a.message.getBody().getStream();
152 if (s == null) break;
153 if (s.startsWith(".")) print(".");
159 public void handleRequest(Connection conn) {
161 conn.setTimeout(30 * 60 * 1000);
162 conn.setNewline("\r\n");
163 println("200 " + conn.vhost + " [" + NNTP.class.getName() + "]");
166 Account account = login.anonymous();
167 this.api = account == null ? null : new MailboxWrapper(account.getMailbox(NNTP.class), true);
168 for(String line = conn.readln(); line != null; line = conn.readln()) try {
169 Log.warn("[nntp-read]", line);
170 StringTokenizer st = new StringTokenizer(line, " ");
171 String command = st.nextToken().toUpperCase();
172 if (command.equals("AUTHINFO")) {
173 // FIXME technically the RFC says we need to use this info to generate a SEnder: header...
174 String uop = st.nextToken().toUpperCase();
175 if (uop.equals("USER")) {
176 user = st.nextToken();
177 println("381 More authentication required");
179 } else if (uop.equals("PASS")) {
180 pass = st.nextToken();
181 account = login.login(user, pass);
182 if (account == null) { println("502 Invalid"); continue; }
183 Mailbox box = account.getMailbox(NNTP.class);
184 this.api = new MailboxWrapper(box, true);
185 println("281 Good to go");
188 throw new Bad("wtf are you talking about?");
190 if (this.api == null) {
191 if (user == null) { println("480 Authentication required"); continue; }
192 if (pass == null) { println("381 Password required"); continue; }
194 if (command.equals("ARTICLE")) { article(st.hasMoreTokens() ? st.nextToken() : null, true, true);
195 } else if (command.equals("HEAD")) { article(st.hasMoreTokens() ? st.nextToken() : null, true, false);
196 } else if (command.equals("DATE")) {
198 println("111 " + dateFormat.format(new Date()));
199 } else if (command.equals("MODE")) {
200 if (st.hasMoreTokens()) {
201 String arg = st.nextToken();
202 if (arg.equalsIgnoreCase("STREAM"));
204 println("203 Streaming permitted");
206 println("201 Hello, you can post.");
208 } else if (command.equals("BODY")) { article(st.hasMoreTokens() ? st.nextToken() : null, false, true);
209 } else if (command.equals("STAT")) { article(st.hasMoreTokens() ? st.nextToken() : null, false, false);
210 } else if (command.equals("HELP")) { println("100 you are beyond help."); println(".");
211 } else if (command.equals("SLAVE")) { println("220 I don't care");
212 } else if (command.equals("XOVER")) {
213 println("224 Overview information follows");
214 MailboxWrapper api = (MailboxWrapper)this.api;
215 String range = st.hasMoreTokens() ? st.nextToken() : (api.ptr+"-"+api.ptr);
216 int start = Integer.parseInt(range.substring(0, range.indexOf('-')));
217 int end = Integer.parseInt(range.substring(range.indexOf('-') + 1));
218 Mailbox.Iterator it = api.current.iterator(Query.messagenum(start, end));
221 Message m = it.cur();
222 println(it.num()+"\t"+m.subject+"\t"+m.from+"\t"+m.date+"\t"+m.messageid+"\t"+
223 m.headers.get("references") + "\t" + m.getLength() + "\t" + m.getNumLines());
224 } catch (Exception e) { Log.error(this, e); }
227 } else if (command.equals("LAST")) { Article a = api.last(); println("223 "+a.num+" "+a.message.messageid+" ok");
228 } else if (command.equals("NEXT")) { Article a = api.next(); println("223 "+a.num+" "+a.message.messageid+" ok");
229 } else if (command.equals("QUIT")) { println("205 Bye."); conn.close(); return;
230 } else if (command.equals("GROUP")) {
231 Group g = api.group(st.nextToken().toLowerCase());
232 if (g==null) println("411 no such group");
233 else println("211 " + g.count + " " + g.first + " " + g.last + " " + g.name);
234 } else if (command.equals("NEWGROUPS") || command.equals("NEWNEWS")) {
235 // FIXME: * and ! unsupported
236 // NEWNEWS is often not supported
237 String groups = command.equals("NEWNEWS") ? st.nextToken() : null;
238 String datetime = st.nextToken() + " " + st.nextToken();
239 String gmt = st.nextToken();
240 String distributions = gmt.equals("GMT") ? (st.hasMoreTokens() ? st.nextToken() : "") : gmt;
241 while(st.hasMoreTokens()) distributions += " " + st.nextToken();
243 // FIXME deal with GMT
246 d = new SimpleDateFormat("yyMMDD HHMMSS").parse(datetime);
247 } catch (ParseException pe) {
250 distributions = distributions.trim();
251 if (distributions.startsWith("<")) distributions = distributions.substring(1, distributions.length() - 1);
253 st = new StringTokenizer(distributions, ",");
254 String[] dists = new String[st.countTokens()];
255 for(int i=0; st.hasMoreTokens(); i++) dists[i] = st.nextToken();
257 if (command.equals("NEWGROUPS")) {
258 Group[] g = api.newgroups(d, dists);
259 println("231 list of groups follows");
260 for(int i=0; i<g.length; i++)
261 println(g[i].name + " " + g[i].last + " " + g[i].first + " " + (g[i].post ? "y" : "n"));
264 st = new StringTokenizer(groups, ",");
265 String[] g = new String[st.countTokens()];
266 for(int i=0; st.hasMoreTokens(); i++) g[i] = st.nextToken();
267 String[] a = api.newnews(g, d, dists);
268 println("230 list of article messageids follows");
269 for(int i=0; i<a.length; i++) println(a[i]);
273 } else if (command.equals("POST")) {
275 // add NNTP-Posting-Host header
276 // Path header: prepend <myname>, (any punctuation separates the list)
277 // Expires header: the date when expiration happens (??) should we ignore this?
278 // Control header: body is the command. Inteprert posts to all.all.ctl as control messages, use Subject line if no Cntrol line
279 // "Approved" line is used for moderaion
280 // Xref: drop this header if you see it
283 // cancel <Message-ID> (do not forward if I am unable to cancel locally)
284 // ihave/sendme: do not support
285 // newgroup <groupname> [moderated] -- body of message is a description of the group
286 // rmgroup <groupname>
288 boolean postok = api.postok();
290 println("440 no posting allowed");
292 println("340 send the article");
293 StringBuffer buf = new StringBuffer();
295 String s = conn.readln();
296 if (s == null) throw new RuntimeException("connection closed");
297 if (s.equals(".")) break;
298 if (s.startsWith(".")) s = s.substring(1);
299 buf.append(s + "\r\n");
301 String body = buf.toString();
303 Message m = Message.newMessage(new Fountain.StringFountain(body));
304 if (m.headers.get("newsgroups")==null)
305 println("441 posted messages must have a Newsgroups header per RFC 977");
306 else if (m.headers.get("newsgroups").indexOf('*')!=-1)
307 println("441 Newsgroups header in posted messages may not contain wildcards (*) per RFC 977");
308 else if (m.headers.get("subject")==null)
309 println("441 posted messages must have a Subject header per RFC 977");
310 // else if (m.headers.get("path")==null)
311 //println("441 posted messages must have a Path header per RFC 977");
312 else if (m.headers.get("from")==null)
313 println("441 posted messages must have a From header per RFC 977");
314 else if (m.headers.get("date")==null)
315 println("441 posted messages must have a Date header per RFC 977");
318 println("240 article posted ok");
320 } catch (Exception e) {
322 println("441 posting failed: " + e);
326 } else if (command.equals("XROVER")) {
327 // equivalent to "XHDR References"
328 } else if (command.equals("XHDR")) {
329 // argument: header name
330 // argument: 1 | 1- | 1-2 | <mid> | nothing (use current article)
332 // print art#+header for all matching messages
334 // 412 if no group selected and numeric form used
335 // 430 if <mid> and not found
336 // 420 if no messages in range
337 } else if (command.equals("XPAT")) {
338 // just like XHDR, but a pattern follows the last argument (may contain whitespace)
342 } else if (command.equals("LIST")) {
343 if (st.hasMoreTokens()) {
344 String argument = st.nextToken().toUpperCase();
345 if (argument.equalsIgnoreCase("EXTENSIONS")) {
346 println("202 Extensions supported:");
347 println("STREAMING");
350 } else if (argument.equals("ACTIVE")) {
351 String wildmat = st.hasMoreTokens() ? st.nextToken() : null;
352 // FIXME: deal with wildmat
353 // just like list, but only show active groups
354 throw new Bad("not implemented yet");
355 } else if (argument.equals("SUBSCRIPTIONS")) {
356 // FIXME: show 215, default subscription list for new users, period
357 } else if (argument.equals("OVERVIEW.FMT")) {
358 println("215 Overview format:");
362 println("Message-ID:");
363 println("References:");
366 //println("Xref:full");
368 } else if (argument.equals("NEWSGROUPS")) {
369 String wildmat = st.hasMoreTokens() ? st.nextToken() : null;
370 // respond 215, print each newsgroup, a space, and the description; end with lone period
375 Group[] g = api.list();
376 println("215 list of groups follows");
377 for(int i=0; i<g.length; i++)
378 println(g[i].name + " " + g[i].last + " " + g[i].first + " " + (g[i].post ? "y" : "n"));
382 } else if (command.equals("LISTGROUP")) {
383 String groupname = st.hasMoreTokens() ? st.nextToken() : null;
384 // 211, all article numbers in group, period. Set article ptr to first item in group
386 } else if (command.equals("XGTITLE")) {
387 String wildmat = st.hasMoreTokens() ? st.nextToken() : null;
388 // 282, then identical to LIST NEWSGROUP
390 } else if (command.equals("CHECK")) {
391 // FIXME: may be pipelined; must spawn threads
392 String mid = st.nextToken();
393 boolean want = api.ihave(mid);
395 println("438 "+ mid+" No thanks");
397 println("238 "+mid+" Yes, I'd like that");
400 } else if (command.equals("TAKETHIS")) {
401 // FIXME: may be pipelined
402 String mid = st.nextToken();
403 // MUST read message here
406 println("439 "+ mid+" Transfer failed");
408 println("239 "+mid+" Rock on.");
412 } else if (command.equals("IHAVE")) {
413 boolean want = api.ihave(st.nextToken());
415 println("435 No thanks");
417 println("335 Proceed");
418 // FIXME read article here
419 println("235 Got it");
422 throw new Bad("wtf are you talking about?");
424 } catch (No n) { println(n.code + " " + n.getMessage());
425 } catch (Bad b) { println(b.code + " " + b.getMessage()); Log.warn(this, b); }