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); }
69 public Group group(String s) {
71 Group g = getgroup(s);
72 if (g==null) return null;
77 public boolean ihave(String messageid) { /* FEATURE */ return false; }
79 public Article next() { return article(ptr++, false, false); }
80 public Article last() { return article(ptr--, false, false); }
81 public Article article(String i, boolean h, boolean b) { return article(Query.header("message-id",i),h,b); }
82 public Article article(int n, boolean h, boolean b) { ptr = n; return article(Query.messagenum(n,n),h,b); }
83 private Article article(Query q, boolean head, boolean body) {
84 Mailbox.Iterator it = current.iterator(q);
85 if (!it.next()) return null;
87 Message m = body ? it.cur() : Message.newMessage(new Fountain.StringFountain(it.head() + "\r\n"));
88 return new Article(it.num(), m);
89 } catch (Exception e) { return null; }
91 public Group[] list() { return list(root, ""); }
92 private Group[] list(Mailbox who, String prefix) {
94 if (who == null) who = root;
95 String[] s = who.children();
96 for(int i=0; i<s.length; i++) {
97 v.addElement(new Group(prefix + s[i], true, 0, 0, 0)); // FIXME numbers
98 Group[] g2 = list(who.slash(s[i], false), prefix + s[i] + ".");
99 for(int j=0; j<g2.length; j++) v.addElement(g2[j]);
101 Group[] ret = new Group[v.size()];
106 private void setgroup(String s) {
107 Mailbox ncurrent = root;
108 for(StringTokenizer st = new StringTokenizer(s, ".");
109 ncurrent != null && st.hasMoreTokens();
110 ncurrent = ncurrent.slash(st.nextToken(), false));
111 if (ncurrent!=null) current=ncurrent;
113 private Group getgroup(String s) {
115 for(StringTokenizer st = new StringTokenizer(s, "."); box!=null && st.hasMoreTokens(); box = box.slash(st.nextToken(), false));
116 if (box==null) return null;
117 return new Group(s, true, 1, box.count(Query.all()), box.count(Query.all()));
120 public Group[] newgroups(Date d, String[] distributions) { /* FEATURE */ return new Group[] { }; }
121 public String[] newnews(String[] groups, Date d, String[] distributions) { /* FIXME */ return null; }
124 public static class Listener {
125 private Server api = null;
127 private Connection conn;
128 public Listener(Login l) { this.login = l; }
130 private void println(String s) { Log.warn("[nntp-write]", s); conn.println(s); }
131 private void println() { Log.warn("[nntp-write]", ""); conn.println(""); }
132 private void print(String s) { Log.warn("[nntp-write]", s); conn.print(s); }
134 private void article(String numOrMessageId, boolean head, boolean body) {
135 String s = numOrMessageId.trim();
137 if (s.startsWith("<")) a = api.article(s.substring(0, s.length() - 1), head, body);
138 else a = api.article(Integer.parseInt(s), head, body);
140 println("423 No such article.");
143 int code = (head && body) ? 220 : head ? 221 : body ? 222 : 223;
144 println(code + " " + a.num + " <" + a.message.messageid + "> get ready for some stuff...");
145 if (head) println(a.message.headers.getString());
146 if (head && body) println();
148 Stream stream = a.message.getBody().getStream();
151 if (s == null) break;
152 if (s.startsWith(".")) print(".");
158 public void handleRequest(Connection conn) {
160 conn.setTimeout(30 * 60 * 1000);
161 conn.setNewline("\r\n");
162 println("200 " + conn.vhost + " [" + NNTP.class.getName() + "]");
165 Account account = login.anonymous();
166 this.api = account == null ? null : new MailboxWrapper(account.getMailbox(NNTP.class), true);
167 for(String line = conn.readln(); line != null; line = conn.readln()) try {
168 Log.warn("[nntp-read]", line);
169 StringTokenizer st = new StringTokenizer(line, " ");
170 String command = st.nextToken().toUpperCase();
171 if (command.equals("AUTHINFO")) {
172 // FIXME technically the RFC says we need to use this info to generate a SEnder: header...
173 String uop = st.nextToken().toUpperCase();
174 if (uop.equals("USER")) user = st.nextToken();
175 else if (uop.equals("PASS")) pass = st.nextToken();
178 if (this.api == null) {
179 if (user == null) { println("480 Authentication required"); continue; }
180 if (pass == null) { println("381 Password required"); continue; }
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 if (command.equals("ARTICLE")) { article(st.hasMoreTokens() ? st.nextToken() : null, true, true);
189 } else if (command.equals("HEAD")) { article(st.hasMoreTokens() ? st.nextToken() : null, true, false);
190 } else if (command.equals("DATE")) {
192 println("111 " + dateFormat.format(new Date()));
193 } else if (command.equals("MODE")) {
194 if (st.hasMoreTokens()) {
195 String arg = st.nextToken();
196 if (arg.equalsIgnoreCase("STREAM"));
198 println("203 Streaming permitted");
200 println("201 Hello, you can post.");
202 } else if (command.equals("BODY")) { article(st.hasMoreTokens() ? st.nextToken() : null, false, true);
203 } else if (command.equals("STAT")) { article(st.hasMoreTokens() ? st.nextToken() : null, false, false);
204 } else if (command.equals("HELP")) { println("100 you are beyond help."); println(".");
205 } else if (command.equals("SLAVE")) { println("220 I don't care");
206 } else if (command.equals("XOVER")) {
207 println("224 Overview information follows");
208 MailboxWrapper api = (MailboxWrapper)this.api;
209 String range = st.hasMoreTokens() ? st.nextToken() : (api.ptr+"-"+api.ptr);
210 int start = Integer.parseInt(range.substring(0, range.indexOf('-')));
211 int end = Integer.parseInt(range.substring(range.indexOf('-') + 1));
212 Mailbox.Iterator it = api.current.iterator(Query.messagenum(start, end));
215 Message m = it.cur();
216 println(it.num()+"\t"+m.subject+"\t"+m.from+"\t"+m.date+"\t"+m.messageid+"\t"+
217 m.headers.get("references") + "\t" + m.getLength() + "\t" + m.getNumLines());
218 } catch (Exception e) { Log.error(this, e); }
221 } else if (command.equals("LAST")) { Article a = api.last(); println("223 "+a.num+" "+a.message.messageid+" ok");
222 } else if (command.equals("NEXT")) { Article a = api.next(); println("223 "+a.num+" "+a.message.messageid+" ok");
223 } else if (command.equals("QUIT")) { println("205 Bye."); conn.close(); return;
224 } else if (command.equals("GROUP")) {
225 Group g = api.group(st.nextToken().toLowerCase());
226 if (g==null) println("411 no such group");
227 else println("211 " + g.count + " " + g.first + " " + g.last + " " + g.name);
228 } else if (command.equals("NEWGROUPS") || command.equals("NEWNEWS")) {
229 // FIXME: * and ! unsupported
230 // NEWNEWS is often not supported
231 String groups = command.equals("NEWNEWS") ? st.nextToken() : null;
232 String datetime = st.nextToken() + " " + st.nextToken();
233 String gmt = st.nextToken();
234 String distributions = gmt.equals("GMT") ? (st.hasMoreTokens() ? st.nextToken() : "") : gmt;
235 while(st.hasMoreTokens()) distributions += " " + st.nextToken();
237 // FIXME deal with GMT
240 d = new SimpleDateFormat("yyMMDD HHMMSS").parse(datetime);
241 } catch (ParseException pe) {
244 distributions = distributions.trim();
245 if (distributions.startsWith("<")) distributions = distributions.substring(1, distributions.length() - 1);
247 st = new StringTokenizer(distributions, ",");
248 String[] dists = new String[st.countTokens()];
249 for(int i=0; st.hasMoreTokens(); i++) dists[i] = st.nextToken();
251 if (command.equals("NEWGROUPS")) {
252 Group[] g = api.newgroups(d, dists);
253 println("231 list of groups follows");
254 for(int i=0; i<g.length; i++)
255 println(g[i].name + " " + g[i].last + " " + g[i].first + " " + (g[i].post ? "y" : "n"));
258 st = new StringTokenizer(groups, ",");
259 String[] g = new String[st.countTokens()];
260 for(int i=0; st.hasMoreTokens(); i++) g[i] = st.nextToken();
261 String[] a = api.newnews(g, d, dists);
262 println("230 list of article messageids follows");
263 for(int i=0; i<a.length; i++) println(a[i]);
267 } else if (command.equals("POST")) {
268 // add NNTP-Posting-Host header
270 // required headers: Newsgroups, Subject, Message-ID, Path, From, Date. No wildcars in newsgroups list
271 // Path header: prepend <myname>, (any punctuation separates the list)
272 // Expires header: the date when expiration happens (??) should we ignore this?
273 // Control header: body is the command. Inteprert posts to all.all.ctl as control messages, use Subject line if no Cntrol line
274 // "Approved" line is used for moderaion
275 // Xref: drop this header if you see it
278 // cancel <Message-ID> (do not forward if I am unable to cancel locally)
279 // ihave/sendme: do not support
280 // newgroup <groupname> [moderated] -- body of message is a description of the group
281 // rmgroup <groupname>
283 boolean postok = api.postok();
285 println("440 no posting allowed");
287 println("340 send the article");
288 StringBuffer buf = new StringBuffer();
290 String s = conn.readln();
291 if (s == null) throw new RuntimeException("connection closed");
292 if (s.equals(".")) break;
293 if (s.startsWith(".")) s = s.substring(1);
294 buf.append(s + "\r\n");
296 String body = buf.toString();
298 api.post(Message.newMessage(new Fountain.StringFountain(body)));
299 println("240 article posted ok");
300 } catch (Exception e) {
302 println("441 posting failed: " + e);
306 } else if (command.equals("XROVER")) {
307 // equivalent to "XHDR References"
308 } else if (command.equals("XHDR")) {
309 // argument: header name
310 // argument: 1 | 1- | 1-2 | <mid> | nothing (use current article)
312 // print art#+header for all matching messages
314 // 412 if no group selected and numeric form used
315 // 430 if <mid> and not found
316 // 420 if no messages in range
317 } else if (command.equals("XPAT")) {
318 // just like XHDR, but a pattern follows the last argument (may contain whitespace)
322 } else if (command.equals("LIST")) {
323 if (st.hasMoreTokens()) {
324 String argument = st.nextToken().toUpperCase();
325 if (argument.equalsIgnoreCase("EXTENSIONS")) {
326 println("202 Extensions supported:");
327 println("STREAMING");
330 } else if (argument.equals("ACTIVE")) {
331 String wildmat = st.hasMoreTokens() ? st.nextToken() : null;
332 // FIXME: deal with wildmat
333 // just like list, but only show active groups
334 throw new Bad("not implemented yet");
335 } else if (argument.equals("SUBSCRIPTIONS")) {
336 // FIXME: show 215, default subscription list for new users, period
337 } else if (argument.equals("OVERVIEW.FMT")) {
338 println("215 Overview format:");
342 println("Message-ID:");
343 println("References:");
346 //println("Xref:full");
348 } else if (argument.equals("NEWSGROUPS")) {
349 String wildmat = st.hasMoreTokens() ? st.nextToken() : null;
350 // respond 215, print each newsgroup, a space, and the description; end with lone period
355 Group[] g = api.list();
356 println("215 list of groups follows");
357 for(int i=0; i<g.length; i++)
358 println(g[i].name + " " + g[i].last + " " + g[i].first + " " + (g[i].post ? "y" : "n"));
362 } else if (command.equals("LISTGROUP")) {
363 String groupname = st.hasMoreTokens() ? st.nextToken() : null;
364 // 211, all article numbers in group, period. Set article ptr to first item in group
366 } else if (command.equals("XGTITLE")) {
367 String wildmat = st.hasMoreTokens() ? st.nextToken() : null;
368 // 282, then identical to LIST NEWSGROUP
370 } else if (command.equals("CHECK")) {
371 // FIXME: may be pipelined; must spawn threads
372 String mid = st.nextToken();
373 boolean want = api.ihave(mid);
375 println("438 "+ mid+" No thanks");
377 println("238 "+mid+" Yes, I'd like that");
380 } else if (command.equals("TAKETHIS")) {
381 // FIXME: may be pipelined
382 String mid = st.nextToken();
383 // MUST read message here
386 println("439 "+ mid+" Transfer failed");
388 println("239 "+mid+" Rock on.");
392 } else if (command.equals("IHAVE")) {
393 boolean want = api.ihave(st.nextToken());
395 println("435 No thanks");
397 println("335 Proceed");
398 // FIXME read article here
399 println("235 Got it");
402 throw new Bad("wtf are you talking about?");
404 } catch (No n) { println(n.code + " " + n.getMessage());
405 } catch (Bad b) { println(b.code + " " + b.getMessage()); Log.warn(this, b); }