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 post(Message m);
51 public Article article(String messageid, boolean head, boolean body);
52 public Article article(int messagenum, boolean head, boolean body);
53 public Group[] list();
54 public Group[] newgroups(Date d, String[] distributions);
55 public String[] newnews(String[] groups, Date d, String[] distributions);
58 public static class MailboxWrapper implements Server {
59 private final Mailbox root;
60 private Mailbox current;
62 public MailboxWrapper(Mailbox root) { this.root = root; }
63 public Group group(String s) {
65 Group g = getgroup(s);
66 if (g==null) return null;
71 public boolean ihave(String messageid) { /* FEATURE */ return false; }
72 public boolean post(Message m) { /* FEATURE */ return false; }
74 public Article next() { return article(ptr++, false, false); }
75 public Article last() { return article(ptr--, false, false); }
76 public Article article(String i, boolean h, boolean b) { return article(Query.header("message-id",i),h,b); }
77 public Article article(int n, boolean h, boolean b) { ptr = n; return article(Query.messagenum(n,n),h,b); }
78 private Article article(Query q, boolean head, boolean body) {
79 Mailbox.Iterator it = current.iterator(q);
80 if (!it.next()) return null;
82 Message m = body ? it.cur() : Message.newMessage(new Fountain.StringFountain(it.head() + "\r\n"));
83 return new Article(it.num(), m);
84 } catch (Exception e) { return null; }
86 public Group[] list() { return list(root, ""); }
87 private Group[] list(Mailbox who, String prefix) {
89 if (who == null) who = root;
90 String[] s = who.children();
91 for(int i=0; i<s.length; i++) {
92 v.addElement(new Group(prefix + s[i], true, 0, 0, 0)); // FIXME numbers
93 Group[] g2 = list(who.slash(s[i], false), prefix + s[i] + ".");
94 for(int j=0; j<g2.length; j++) v.addElement(g2[j]);
96 Group[] ret = new Group[v.size()];
101 private void setgroup(String s) {
102 Mailbox ncurrent = root;
103 for(StringTokenizer st = new StringTokenizer(s, ".");
104 ncurrent != null && st.hasMoreTokens();
105 ncurrent = ncurrent.slash(st.nextToken(), false));
106 if (ncurrent!=null) current=ncurrent;
108 private Group getgroup(String s) {
110 for(StringTokenizer st = new StringTokenizer(s, "."); box!=null && st.hasMoreTokens(); box = box.slash(st.nextToken(), false));
111 if (box==null) return null;
112 return new Group(s, true, 1, box.count(Query.all()), box.count(Query.all()));
115 public Group[] newgroups(Date d, String[] distributions) { /* FEATURE */ return new Group[] { }; }
116 public String[] newnews(String[] groups, Date d, String[] distributions) { /* FIXME */ return null; }
119 public static class Listener {
120 private Server api = null;
122 private Connection conn;
123 public Listener(Login l) { this.login = l; }
125 private void println(String s) { Log.warn("[nntp-write]", s); conn.println(s); }
126 private void println() { Log.warn("[nntp-write]", ""); conn.println(""); }
127 private void print(String s) { Log.warn("[nntp-write]", s); conn.print(s); }
129 private void article(String numOrMessageId, boolean head, boolean body) {
130 String s = numOrMessageId.trim();
132 if (s.startsWith("<")) a = api.article(s.substring(0, s.length() - 1), head, body);
133 else a = api.article(Integer.parseInt(s), head, body);
135 println("423 No such article.");
138 int code = (head && body) ? 220 : head ? 221 : body ? 222 : 223;
139 println(code + " " + a.num + " <" + a.message.messageid + "> get ready for some stuff...");
140 if (head) println(a.message.headers.getString());
141 if (head && body) println();
143 Stream stream = a.message.getBody().getStream();
146 if (s == null) break;
147 if (s.startsWith(".")) print(".");
153 public void handleRequest(Connection conn) {
155 conn.setTimeout(30 * 60 * 1000);
156 conn.setNewline("\r\n");
157 println("200 " + conn.vhost + " [" + NNTP.class.getName() + "]");
160 Account account = login.anonymous();
161 this.api = account == null ? null : new MailboxWrapper(account.getMailbox(NNTP.class));
162 for(String line = conn.readln(); line != null; line = conn.readln()) try {
163 Log.warn("[nntp-read]", line);
164 StringTokenizer st = new StringTokenizer(line, " ");
165 String command = st.nextToken().toUpperCase();
166 if (command.equals("AUTHINFO")) {
167 // FIXME technically the RFC says we need to use this info to generate a SEnder: header...
168 String uop = st.nextToken().toUpperCase();
169 if (uop.equals("USER")) user = st.nextToken();
170 else if (uop.equals("PASS")) pass = st.nextToken();
173 if (this.api == null) {
174 if (user == null) { println("480 Authentication required"); continue; }
175 if (pass == null) { println("381 Password required"); continue; }
176 account = login.login(user, pass);
177 if (account == null) { println("502 Invalid"); continue; }
178 this.api = new MailboxWrapper(account.getMailbox(NNTP.class));
179 println("281 Good to go");
182 if (command.equals("ARTICLE")) { article(st.hasMoreTokens() ? st.nextToken() : null, true, true);
183 } else if (command.equals("HEAD")) { article(st.hasMoreTokens() ? st.nextToken() : null, true, false);
184 } else if (command.equals("DATE")) {
186 println("111 " + dateFormat.format(new Date()));
187 } else if (command.equals("MODE")) {
188 if (st.hasMoreTokens()) {
189 String arg = st.nextToken();
190 if (arg.equalsIgnoreCase("STREAM"));
192 println("203 Streaming permitted");
194 println("201 Hello, you can post.");
196 } else if (command.equals("BODY")) { article(st.hasMoreTokens() ? st.nextToken() : null, false, true);
197 } else if (command.equals("STAT")) { article(st.hasMoreTokens() ? st.nextToken() : null, false, false);
198 } else if (command.equals("HELP")) { println("100 you are beyond help."); println(".");
199 } else if (command.equals("SLAVE")) { println("220 I don't care");
200 } else if (command.equals("XOVER")) {
201 println("224 Overview information follows");
202 MailboxWrapper api = (MailboxWrapper)this.api;
203 String range = st.hasMoreTokens() ? st.nextToken() : (api.ptr+"-"+api.ptr);
204 int start = Integer.parseInt(range.substring(0, range.indexOf('-')));
205 int end = Integer.parseInt(range.substring(range.indexOf('-') + 1));
206 Mailbox.Iterator it = api.current.iterator(Query.messagenum(start, end));
209 Message m = it.cur();
210 println(it.num()+"\t"+m.subject+"\t"+m.from+"\t"+m.date+"\t"+m.messageid+"\t"+
211 m.headers.get("references") + "\t" + m.getLength() + "\t" + m.getNumLines());
212 } catch (Exception e) { Log.error(this, e); }
215 } else if (command.equals("LAST")) { Article a = api.last(); println("223 "+a.num+" "+a.message.messageid+" ok");
216 } else if (command.equals("NEXT")) { Article a = api.next(); println("223 "+a.num+" "+a.message.messageid+" ok");
217 } else if (command.equals("QUIT")) { println("205 Bye."); conn.close(); return;
218 } else if (command.equals("GROUP")) {
219 Group g = api.group(st.nextToken().toLowerCase());
220 if (g==null) println("411 no such group");
221 else println("211 " + g.count + " " + g.first + " " + g.last + " " + g.name);
222 } else if (command.equals("NEWGROUPS") || command.equals("NEWNEWS")) {
223 // FIXME: * and ! unsupported
224 // NEWNEWS is often not supported
225 String groups = command.equals("NEWNEWS") ? st.nextToken() : null;
226 String datetime = st.nextToken() + " " + st.nextToken();
227 String gmt = st.nextToken();
228 String distributions = gmt.equals("GMT") ? (st.hasMoreTokens() ? st.nextToken() : null) : gmt;
229 while(st.hasMoreTokens()) distributions += " " + st.nextToken();
230 // FIXME deal with GMT
233 d = new SimpleDateFormat("yyMMDD HHMMSS").parse(gmt);
234 } catch (ParseException pe) {
237 distributions = distributions.trim();
238 if (distributions.startsWith("<")) distributions = distributions.substring(1, distributions.length() - 1);
240 st = new StringTokenizer(distributions, ",");
241 String[] dists = new String[st.countTokens()];
242 for(int i=0; st.hasMoreTokens(); i++) dists[i] = st.nextToken();
244 if (command.equals("NEWGROUPS")) {
245 Group[] g = api.newgroups(d, dists);
246 println("231 list of groups follows");
247 for(int i=0; i<g.length; i++)
248 println(g[i].name + " " + g[i].last + " " + g[i].first + " " + (g[i].post ? "y" : "n"));
251 st = new StringTokenizer(groups, ",");
252 String[] g = new String[st.countTokens()];
253 for(int i=0; st.hasMoreTokens(); i++) g[i] = st.nextToken();
254 String[] a = api.newnews(g, d, dists);
255 println("230 list of article messageids follows");
256 for(int i=0; i<a.length; i++) println(a[i]);
260 } else if (command.equals("POST")) {
261 // add NNTP-Posting-Host header
263 // required headers: Newsgroups, Subject, Message-ID, Path, From, Date. No wildcars in newsgroups list
264 // Path header: prepend <myname>, (any punctuation separates the list)
265 // Expires header: the date when expiration happens (??) should we ignore this?
266 // Control header: body is the command. Inteprert posts to all.all.ctl as control messages, use Subject line if no Cntrol line
267 // "Approved" line is used for moderaion
268 // Xref: drop this header if you see it
271 // cancel <Message-ID> (do not forward if I am unable to cancel locally)
272 // ihave/sendme: do not support
273 // newgroup <groupname> [moderated] -- body of message is a description of the group
274 // rmgroup <groupname>
277 boolean postok = api.post();
279 println("440 no posting allowed");
282 println("340 send the article");
283 // FIME read the article here
284 println("240 article posted ok");
287 } else if (command.equals("XROVER")) {
288 // equivalent to "XHDR References"
289 } else if (command.equals("XHDR")) {
290 // argument: header name
291 // argument: 1 | 1- | 1-2 | <mid> | nothing (use current article)
293 // print art#+header for all matching messages
295 // 412 if no group selected and numeric form used
296 // 430 if <mid> and not found
297 // 420 if no messages in range
298 } else if (command.equals("XPAT")) {
299 // just like XHDR, but a pattern follows the last argument (may contain whitespace)
303 } else if (command.equals("LIST")) {
304 if (st.hasMoreTokens()) {
305 String argument = st.nextToken().toUpperCase();
306 if (argument.equalsIgnoreCase("EXTENSIONS")) {
307 println("202 Extensions supported:");
308 println("STREAMING");
311 } else if (argument.equals("ACTIVE")) {
312 String wildmat = st.hasMoreTokens() ? st.nextToken() : null;
313 // FIXME: deal with wildmat
314 // just like list, but only show active groups
315 throw new Bad("not implemented yet");
316 } else if (argument.equals("SUBSCRIPTIONS")) {
317 // FIXME: show 215, default subscription list for new users, period
318 } else if (argument.equals("OVERVIEW.FMT")) {
319 println("215 Overview format:");
323 println("Message-ID:");
324 println("References:");
327 //println("Xref:full");
329 } else if (argument.equals("NEWSGROUPS")) {
330 String wildmat = st.hasMoreTokens() ? st.nextToken() : null;
331 // respond 215, print each newsgroup, a space, and the description; end with lone period
336 Group[] g = api.list();
337 println("215 list of groups follows");
338 for(int i=0; i<g.length; i++)
339 println(g[i].name + " " + g[i].last + " " + g[i].first + " " + (g[i].post ? "y" : "n"));
343 } else if (command.equals("LISTGROUP")) {
344 String groupname = st.hasMoreTokens() ? st.nextToken() : null;
345 // 211, all article numbers in group, period. Set article ptr to first item in group
347 } else if (command.equals("XGTITLE")) {
348 String wildmat = st.hasMoreTokens() ? st.nextToken() : null;
349 // 282, then identical to LIST NEWSGROUP
351 } else if (command.equals("CHECK")) {
352 // FIXME: may be pipelined; must spawn threads
353 String mid = st.nextToken();
354 boolean want = api.ihave(mid);
356 println("438 "+ mid+" No thanks");
358 println("238 "+mid+" Yes, I'd like that");
361 } else if (command.equals("TAKETHIS")) {
362 // FIXME: may be pipelined
363 String mid = st.nextToken();
364 // MUST read message here
367 println("439 "+ mid+" Transfer failed");
369 println("239 "+mid+" Rock on.");
373 } else if (command.equals("IHAVE")) {
374 boolean want = api.ihave(st.nextToken());
376 println("435 No thanks");
378 println("335 Proceed");
379 // FIXME read article here
380 println("235 Got it");
383 throw new Bad("wtf are you talking about?");
385 } catch (No n) { println(n.code + " " + n.getMessage());
386 } catch (Bad b) { println(b.code + " " + b.getMessage()); Log.warn(this, b); }