Return-Path: Delivered-To: apmail-jakarta-commons-dev-archive@apache.org Received: (qmail 59784 invoked from network); 7 Aug 2003 17:26:27 -0000 Received: from exchange.sun.com (192.18.33.10) by daedalus.apache.org with SMTP; 7 Aug 2003 17:26:27 -0000 Received: (qmail 1340 invoked by uid 97); 7 Aug 2003 17:29:09 -0000 Delivered-To: qmlist-jakarta-archive-commons-dev@nagoya.betaversion.org Received: (qmail 1333 invoked from network); 7 Aug 2003 17:29:08 -0000 Received: from daedalus.apache.org (HELO apache.org) (208.185.179.12) by nagoya.betaversion.org with SMTP; 7 Aug 2003 17:29:08 -0000 Received: (qmail 58404 invoked by uid 500); 7 Aug 2003 17:26:12 -0000 Mailing-List: contact commons-dev-help@jakarta.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Subscribe: List-Help: List-Post: List-Id: "Jakarta Commons Developers List" Reply-To: "Jakarta Commons Developers List" Delivered-To: mailing list commons-dev@jakarta.apache.org Received: (qmail 58327 invoked from network); 7 Aug 2003 17:26:11 -0000 Received: from homer.telewest.co.uk (193.38.83.123) by daedalus.apache.org with SMTP; 7 Aug 2003 17:26:11 -0000 Received: (qmail 10256 invoked from network); 7 Aug 2003 17:25:08 -0000 Received: from unknown (HELO tw-smtp-2) (193.38.83.33) by homer.telewest.co.uk with SMTP; 7 Aug 2003 17:25:08 -0000 Received: from 193.38.83.35 by tw-smtp-3 with ESMTP ( (MMS v5.5.3)); Thu, 07 Aug 2003 18:26:05 +0100 Received: by wk-ims-xchg-1.telewest.co.uk with Internet Mail Service ( 5.5.2655.55) id ; Thu, 7 Aug 2003 18:25:56 +0100 Message-ID: <28A14E493353D511912C00508BB9BAD00A39E554@wkxchg.telewest.co.uk> From: "Rory Winston" To: "'Jakarta Commons Developers List'" Subject: RE: [net][patch] jdk 1.4 specific call in VMSFTPEntryParser.java Date: Thu, 7 Aug 2003 18:24:52 +0100 MIME-Version: 1.0 X-Mailer: Internet Mail Service (5.5.2655.55) X-WSS-ID: 132C542798727-01-01 Content-Type: multipart/mixed; boundary="----_=_NextPart_000_01C35D08.CFCE2120" X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N ------_=_NextPart_000_01C35D08.CFCE2120 Content-Type: text/plain; charset=iso-8859-1 Content-Transfer-Encoding: 7bit Hi, I've cleaned up a bit (applied my changes to a fresh checkout) and generated a diff file. I've taken out the XHDR addition for now, as XOVER seems to be the preferred mechanism for this kind of thing. The functionality added is: 1. XOVER 2. Authentication via AUTHINFO USER + AUTHINFO PASS 3. LIST ACTIVE I've also supplied a sample class, very quickly stitched together that shows the new features in action. Hopefully this may be considered clean enough to make a 1.1 release. I'd love to hear any feedback on these features. PS Does anyone else use the Eclipse feature "Check out as Java Project...." from the Jakarta CVS repository? Great stuff :) Cheers Rory (Patch file attached and copied/pasted in) Index: src/java/examples/ExtendedNNTPOps.java =================================================================== RCS file: src/java/examples/ExtendedNNTPOps.java diff -N src/java/examples/ExtendedNNTPOps.java --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ src/java/examples/ExtendedNNTPOps.java 7 Aug 2003 17:14:30 -0000 @@ -0,0 +1,192 @@ + +package examples; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.Reader; +import java.util.ArrayList; +import java.util.StringTokenizer; + +import org.apache.commons.net.io.DotTerminatedMessageReader; +import org.apache.commons.net.nntp.NNTPClient; +import org.apache.commons.net.nntp.NewsgroupInfo; + +/** + * @author root + * + * To change the template for this generated type comment go to + * Window>Preferences>Java>Code Generation>Code and Comments + */ +public class ExtendedNNTPOps { + + NNTPClient client; + + public ExtendedNNTPOps() { + client = new NNTPClient(); + try { + client.connect("news.blueyonder.co.uk"); + + // AUTHINFO USER/AUTHINFO PASS + boolean success = client.authenticate("foo", "bar"); + if(success) + { + System.out.println("Authentication succeeded"); + } + else + { + System.out.println("Authentication failed, error =" + client.getReplyString()); + } + + // XOVER + NewsgroupInfo testGroup = new NewsgroupInfo(); + client.selectNewsgroup("alt.test", testGroup); + int lowArticleNumber = testGroup.getFirstArticle(); + int highArticleNumber = testGroup.getLastArticle(); + Article[] articles = getArticleInfo(lowArticleNumber, highArticleNumber); + + for(int i =0; i < articles.length; ++i) + { + System.out.println(articles[i].getSubject()); + } + + // LIST ACTIVE + NewsgroupInfo[] fanGroups = client.listNewsgroups("alt.fan.*"); + for(int i = 0; i < fanGroups.length; ++i) + { + System.out.println(fanGroups[i].getNewsgroup()); + } + + + } + catch(IOException e) { + e.printStackTrace(); + } + } + + private Article[] getArticleInfo(int lowArticleNumber, int highArticleNumber) throws IOException + { + ArrayList articles = new ArrayList(); + Reader reader = null; + String theMessage; + char[] buffer = new char[128]; + + reader = (DotTerminatedMessageReader) client.retrieveArticleInfo(lowArticleNumber, highArticleNumber); + + if (reader != null) { + String theInfo = readerToString(reader); + StringTokenizer st = new StringTokenizer(theInfo, "\n"); + + // Extract the article information + // Mandatory format (from NNTP RFC 2980) is : + // Subject\tAuthor\tDate\tID\tReference(s)\tByte Count\tLine Count + while (st.hasMoreTokens()) { + StringTokenizer stt = new StringTokenizer(st.nextToken(), "\t"); + Article article = new Article(); + article.setArticleNumber(Integer.parseInt(stt.nextToken())); + article.setSubject(stt.nextToken()); + article.setFrom(stt.nextToken()); + article.setDate(stt.nextToken()); + article.setArticleId(stt.nextToken()); + article.addHeaderField("References", stt.nextToken()); + articles.add(article); + } + } else { + return null; + } + + return (Article[]) articles.toArray(new Article[articles.size()]); + } + + private String readerToString(Reader reader) + { + String temp; + StringBuffer sb = null; + BufferedReader bufReader = new BufferedReader(reader); + boolean endOfHeader = false; + + sb = new StringBuffer(); + try + { + temp = bufReader.readLine(); + while (temp != null) { + sb.append(temp); + sb.append("\n"); + temp = bufReader.readLine(); + } + } catch (IOException e) { + e.printStackTrace(); + } + + return sb.toString(); + } + + public static void main(String[] args) { + ExtendedNNTPOps ops = new ExtendedNNTPOps(); + } + +} + +// simple class that encapsulates some basic info about an NNTP article + class Article { + + private int articleNumber; + private String subject; + private String date; + private String articleId; + + private String from; + private StringBuffer header; + + public Article() + { + header = new StringBuffer(); + } + + public void addHeaderField(String name, String val) { + header.append(name); + header.append(": "); + header.append(val); + header.append('\n'); + } + + public String getArticleId() { + return articleId; + } + + public int getArticleNumber() { + return articleNumber; + } + + public String getDate() { + return date; + } + + public String getFrom() { + return from; + } + + public String getSubject() { + return subject; + } + + public void setArticleId(String string) { + articleId = string; + } + + public void setArticleNumber(int i) { + articleNumber = i; + } + + public void setDate(String string) { + date = string; + } + + public void setFrom(String string) { + from = string; + } + + public void setSubject(String string) { + subject = string; + } + } + Index: src/java/org/apache/commons/net/nntp/NNTP.java =================================================================== RCS file: /home/cvspublic/jakarta-commons/net/src/java/org/apache/commons/net/nntp/NNT P.java,v retrieving revision 1.5 diff -u -r1.5 NNTP.java --- src/java/org/apache/commons/net/nntp/NNTP.java 19 Apr 2003 20:49:13 -0000 1.5 +++ src/java/org/apache/commons/net/nntp/NNTP.java 7 Aug 2003 17:14:31 -0000 @@ -926,5 +926,81 @@ { return sendCommand(NNTPCommand.QUIT); } + + /*** + * A convenience method to send the AUTHINFO USER command to the server, + * receive the reply, and return the reply code. (See RFC 2980) + *

+ * @param username A valid username. + * @return The reply code received from the server. The server should return a + * 381 or 281 for this command. + * @exception NNTPConnectionClosedException + * If the NNTP server prematurely closes the connection as a result + * of the client being idle or some other reason causing the server + * to send NNTP reply code 400. This exception may be caught either + * as an IOException or independently as itself. + * @exception IOException If an I/O error occurs while either sending the + * command or receiving the server reply. + ***/ + public int authinfoUser(String username) throws IOException { + String userParameter = "USER " + username; + return sendCommand(NNTPCommand.AUTHINFO, userParameter); + } + /*** + * A convenience method to send the AUTHINFO PASS command to the server, + * receive the reply, and return the reply code. If this step is required, it should + * immediately follow the AUTHINFO USER command (See RFC 2980) + *

+ * @param password a valid password. + * @return The reply code received from the server. The server should return a + * 281 or 502 for this command. + * @exception NNTPConnectionClosedException + * If the NNTP server prematurely closes the connection as a result + * of the client being idle or some other reason causing the server + * to send NNTP reply code 400. This exception may be caught either + * as an IOException or independently as itself. + * @exception IOException If an I/O error occurs while either sending the + * command or receiving the server reply. + ***/ + public int authinfoPass(String password) throws IOException { + String passParameter = "PASS " + password; + return sendCommand(NNTPCommand.AUTHINFO, passParameter); + } + + /*** + * A convenience method to send the NNTP XOVER command to the server, + * receive the reply, and return the reply code. + *

+ * @param selectedArticles a String representation of the range of article headers + * required. This may be an article number, or a range of article numbers in the + * form "XXXX-YYYY", where XXXX and YYYY are valid article numbers in the current group. + * It also may be of the form "XXX-", meaning "return XXX and all following articles" + * In this revision, the last format is not possible (yet) + * @return The reply code received from the server. + * @exception NNTPConnectionClosedException + * If the NNTP server prematurely closes the connection as a result + * of the client being idle or some other reason causing the server + * to send NNTP reply code 400. This exception may be caught either + * as an IOException or independently as itself. + * @exception IOException If an I/O error occurs while either sending the + * command or receiving the server reply. + ***/ + public int xover(String selectedArticles) throws IOException { + return sendCommand(NNTPCommand.XOVER, selectedArticles); + } + + /** + * A convenience wrapper for the extended LIST command that takes an argument, + * allowing us to selectively list multiple groups. + *

+ * @param wildmat A wildmat (pseudo-regex) pattern. See RFC 2980 for details. + * @return the reply code received from the server. + * @throws IOException + */ + public int listActive(String wildmat) throws IOException { + StringBuffer command = new StringBuffer("ACTIVE "); + command.append(wildmat); + return sendCommand(NNTPCommand.LIST, command.toString()); + } } Index: src/java/org/apache/commons/net/nntp/NNTPClient.java =================================================================== RCS file: /home/cvspublic/jakarta-commons/net/src/java/org/apache/commons/net/nntp/NNT PClient.java,v retrieving revision 1.4 diff -u -r1.4 NNTPClient.java --- src/java/org/apache/commons/net/nntp/NNTPClient.java 19 Apr 2003 20:49:13 -0000 1.4 +++ src/java/org/apache/commons/net/nntp/NNTPClient.java 7 Aug 2003 17:14:31 -0000 @@ -959,6 +959,22 @@ return __readNewsgroupListing(); } + + /** + * An overloaded listNewsgroups() command that allows us to specify with a pattern + * what groups we want to list. Wraps the LIST ACTIVE command. + *

+ * @param wildmat a pseudo-regex pattern (cf. RFC 2980) + * @return + * @throws IOException + */ + public NewsgroupInfo[] listNewsgroups(String wildmat) throws IOException + { + if(!NNTPReply.isPositiveCompletion(listActive(wildmat))) + return null; + return __readNewsgroupListing(); + } + /*** @@ -1151,5 +1167,74 @@ { return NNTPReply.isPositiveCompletion(quit()); } - + + /** + * Log into a news server by sending the AUTHINFO USER/AUTHINFO PASS command + * sequence. This is usually sent in response to a 480 reply code from the NNTP server. + *

+ * @param username a valid username + * @param password the corresponding password + * @return True for successful login, false for a failure + * @throws IOException + */ + + public boolean authenticate(String username, String password) throws IOException + { + int replyCode = authinfoUser(username); + + if (replyCode == NNTPReply.MORE_AUTH_INFO_REQUIRED) + { + replyCode = authinfoPass(password); + + if (replyCode == NNTPReply.AUTHENTICATION_ACCEPTED) + { + _isAllowedToPost = true; + return true; + } + } + return false; + } + + /*** + * Private implementation of XOVER functionality. + * + * See + * for legal agument formats. Alternatively, read RFC 2980 :-) + *

+ * @param articleRange + * @return Returns a DotTerminatedMessageReader if successful, null otherwise + * @exception IOException + */ + private Reader __retrieveArticleInfo(String articleRange) throws IOException + { + if (!NNTPReply.isPositiveCompletion(xover(articleRange))) + return null; + + return new DotTerminatedMessageReader(_reader_); + } + + /** + * Return article headers for a specified post. + *

+ * @param articleNumber the article to retrieve headers for + * @return a DotTerminatedReader if successful, null otherwise + * @throws IOException + */ + public Reader retrieveArticleInfo(int articleNumber) throws IOException + { + return __retrieveArticleInfo(new Integer(articleNumber).toString()); + } + + /** + * Return article headers for all articles between lowArticleNumber and highArticleNumber, inclusively. + *