1600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang/* 2600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Conditions Of Use 3600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 4600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* This software was developed by employees of the National Institute of 5600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Standards and Technology (NIST), an agency of the Federal Government. 6600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Pursuant to title 15 Untied States Code Section 105, works of NIST 7600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* employees are not subject to copyright protection in the United States 8600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* and are considered to be in the public domain. As a result, a formal 9600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* license is not needed to use the software. 10600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 11600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* This software is provided by NIST as a service and is expressly 12600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED 13600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF 14600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT 15600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* AND DATA ACCURACY. NIST does not warrant or make any representations 16600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* regarding the use of the software or the results thereof, including but 17600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* not limited to the correctness, accuracy, reliability or usefulness of 18600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* the software. 19600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 20600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Permission to use this software is contingent upon your acceptance 21600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* of the terms of this agreement 22600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 23600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* . 24600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 25600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang*/ 26600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangpackage gov.nist.javax.sip.parser; 27600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 28600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangimport gov.nist.core.Token; 29600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangimport gov.nist.javax.sip.header.*; 30600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangimport java.text.ParseException; 31600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 32600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang/** 33600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Parser for UserAgent header. 34600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 35600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @version 1.2 $Revision: 1.15 $ $Date: 2009/07/17 18:58:07 $ 36600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 37600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @author Olivier Deruelle <br/> 38600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @author M. Ranganathan <br/> 39600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 40600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 41600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 42600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangpublic class UserAgentParser extends HeaderParser { 43600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 44600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 45600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Constructor 46600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 47600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param userAgent - 48600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * UserAgent header to parse 49600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 50600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public UserAgentParser(String userAgent) { 51600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang super(userAgent); 52600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 53600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 54600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 55600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Constructor 56600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 57600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param lexer - 58600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * the lexer to use. 59600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 60600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected UserAgentParser(Lexer lexer) { 61600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang super(lexer); 62600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 63600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 64600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 65600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * parse the message. Note that we have losened up on the parsing quite a bit because 66600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * user agents tend to be very bad about specifying the user agent according to RFC. 67600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 68600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return SIPHeader (UserAgent object) 69600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @throws SIPParseException 70600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * if the message does not respect the spec. 71600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 72600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public SIPHeader parse() throws ParseException { 73600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (debug) 74600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang dbg_enter("UserAgentParser.parse"); 75600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang UserAgent userAgent = new UserAgent(); 76600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang try { 77600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang headerName(TokenTypes.USER_AGENT); 78600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (this.lexer.lookAhead(0) == '\n') 79600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw createParseException("empty header"); 80600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 81600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /* 82600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * BNF User-Agent = "User-Agent" HCOLON server-val *(LWS server-val) 83600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * server-val = product / comment product = token [SLASH 84600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * product-version] product-version = token 85600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 86600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang while (this.lexer.lookAhead(0) != '\n' 87600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang && this.lexer.lookAhead(0) != '\0') { 88600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 89600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (this.lexer.lookAhead(0) == '(') { 90600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang String comment = this.lexer.comment(); 91600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang userAgent.addProductToken('(' + comment + ')'); 92600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } else { 93600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang // product = token [SLASHproduct-version] 94600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang // product-version = token 95600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang // The RFC Does NOT allow this space but we are generous in what we accept 96600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 97600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.getLexer().SPorHT(); 98600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 99600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 100600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang String product = this.lexer.byteStringNoSlash(); 101600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if ( product == null ) throw createParseException("Expected product string"); 102600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 103600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang StringBuffer productSb = new StringBuffer(product); 104600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang // do we possibily have the optional product-version? 105600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (this.lexer.peekNextToken().getTokenType() == TokenTypes.SLASH) { 106600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang // yes 107600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.lexer.match(TokenTypes.SLASH); 108600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang // product-version 109600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang // The RFC Does NOT allow this space but we are generous in what we accept 110600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.getLexer().SPorHT(); 111600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 112600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang String productVersion = this.lexer.byteStringNoSlash(); 113600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 114600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if ( productVersion == null ) throw createParseException("Expected product version"); 115600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 116600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang productSb.append("/"); 117600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 118600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang productSb.append(productVersion); 119600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 120600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 121600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang userAgent.addProductToken(productSb.toString()); 122600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 123600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang // LWS 124600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.lexer.SPorHT(); 125600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 126600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } finally { 127600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (debug) 128600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang dbg_leave("UserAgentParser.parse"); 129600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 130600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 131600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return userAgent; 132600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 133600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 134600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 135600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public static void main(String args[]) throws ParseException { String 136600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang userAgent[] = { "User-Agent: Softphone/Beta1.5 \n", "User-Agent:Nist/Beta1 (beta version) \n", "User-Agent: Nist UA (beta version)\n", 137600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang "User-Agent: Nist1.0/Beta2 Ubi/vers.1.0 (very cool) \n" , 138600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang "User-Agent: SJphone/1.60.299a/L (SJ Labs)\n", 139600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang "User-Agent: sipXecs/3.5.11 sipXecs/sipxbridge (Linux)\n"}; 140600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 141600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang for (int i = 0; i < userAgent.length; i++ ) { UserAgentParser parser = 142600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang new UserAgentParser(userAgent[i]); UserAgent ua= (UserAgent) 143600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang parser.parse(); System.out.println("encoded = " + ua.encode()); } 144600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 145600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 146600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang} 147