QueryResponseMsg.java
| Index Score | ||
|---|---|---|
 |
 |
phex.msg |
 |
 |
Phex |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| EXEC_COMMENTS | Comments in executable code |  |
| LINE_COMMENT | Number of line comments | |
| DECL_COMMENTS | Comments in declarations | |
| SIZE | Size of the file in bytes | |
| COMMENTS | Comment lines | |
| DOC_COMMENT | Number of javadoc comment lines | |
| LINES | Number of lines in the source file | |
| LOC | Lines of code | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LOGICAL_LINES | Number of statements | |
| EXITS | Procedure exits | |
| ELOC | Effective lines of code | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| COMPARISONS | Number of comparison operators | |
| BLOCKS | Number of blocks | |
| OPERATORS | Number of operators | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| RETURNS | Number of return points from functions | |
| PROGRAM_LENGTH | Halstead program length | |
| UNIQUE_OPERANDS | Number of unique operands | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0076 | JAVA0076 Use of magic number | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| OPERANDS | Number of operands | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0259 | JAVA0259 Return of collection/array field | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0256 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LOOPS | Number of loops | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* PHEX - The pure-java Gnutella-servent.
* Copyright (C) 2001 - 2008 Phex Development Group
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* --- SVN Information ---
* $Id: QueryResponseMsg.java 4205 2008-06-18 09:49:16Z gregork $
*/
package phex.msg;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.util.HashSet;
import java.util.Set;
import phex.common.URN;
import phex.common.address.DefaultDestAddress;
import phex.common.address.DestAddress;
import phex.common.log.NLogger;
import phex.io.buffer.ByteBuffer;
import phex.prefs.core.LibraryPrefs;
import phex.prefs.core.NetworkPrefs;
import phex.query.QHDConstants;
import phex.security.PhexSecurityManager;
import phex.utils.HexConverter;
import phex.utils.IOUtil;
import phex.xml.XMLUtils;
/**
* <p>A response to a query message.</p>
*
* <p>These should have message IDs matching the query message it is responding
* to.</p>
*
* <p>This class does implement the EQHD extention. It also support the GGEP
* extension.
* </p>
*/
public class QueryResponseMsg extends Message implements QHDConstants
{
private static final boolean INCLUDE_QHD = true;
/**
* push flag mask for beashare metadata.
*/
private static final byte PUSH_NEEDED_MASK=(byte)0x01;
/**
* busy flag mask for beashare metadata.
*/
private static final byte SERVER_BUSY_MASK=(byte)0x04;
/**
* upload flag mask for beashare metadata.
*/
private static final byte HAS_UPLOADED_MASK=(byte)0x08;
/**
* speed flag mask for beashare metadata.
*/
private static final byte UPLOAD_SPEED_MASK=(byte)0x10;
/**
* ggep flag mask for QHD.
*/
private static final byte GGEP_MASK=(byte)0x20;
/**
* chat flag mask for limewire and shareaza metadata.
*/
private static final byte CHAT_SUPPORTED_MASK = (byte)0x01;
/**
* The security service for parsing. Might be null.
*/
private final PhexSecurityManager securityService;
/**
* <p>The un-parsed body of the query response.</p>
*
* <p>For queries that are being forwarded, this body will include all extra
* data. For queries built using this API, there is no way currently to add
* extra information to this body.</p>
*/
private byte[] body;
/**
* Only count each URN once to reduce counted spams.
*/
private short uniqueResultCount;
/**
* Query response records.
*/
private QueryResponseRecord[] records;
/**
* The host address for the query response
*/
private DestAddress destAddress;
private GUID remoteClientID;
/**
* Defines the four character vendor code of the client that offers the
* file.
*/
private String vendorCode;
/**
* <p>Defines if a push transfer is needed or not or unknown.</p>
*
* <p><em>fixme:</em> Why not use a boolean? Same goes for other flags.</p>
*/
private short pushNeededFlag;
/**
* Defines if a server is busy currently or unknown.
*/
private short serverBusyFlag;
/**
* Defines if a the server has already uploaded a file.
*/
private short hasUploadedFlag;
/**
* Defines if the upload speed of a server.
*/
private short uploadSpeedFlag;
/**
* Defines if the server supportes chat.
*/
private boolean isChatSupported;
/**
* Defines if the server supports browse host.
*/
private boolean isBrowseHostSupported;
/**
* The push proxy addresses for the GGEP extension of this query
* response.
*/
private DestAddress[] pushProxyAddresses;
/**
* Defines if the body of the query response is already parsed.
*/
private boolean isParsed;
/**
* Build a new MsgQueryResponse with a header, a client GUID, host address,
* port and speed, and an array of MsgResRecord instances representing hits.
*
* @param header the MsgHeader to attach, which will have its function
* property set to MsgHeader.sQueryResponse
* @param clientID the GUID of the client that requested the query
* @param aHostAddress the DestAddress of the responding servent
* @param speed the speed of the responding servent
* @param records an array of MsgResRecord objects representing hits to
* the query which must be shorter than 256
* @throws IllegalArgumentException if there are more than 255 records
*/
public QueryResponseMsg( MsgHeader header, GUID clientID,
DestAddress aHostAddress, int speed, QueryResponseRecord records[],
DestAddress[] pushProxyAddresses, boolean hasConnectedIncoming,
boolean isHostBusyUploading )
{
super( header );
if( records.length > 255 )
{
throw new IllegalArgumentException(
"A maximum of 255 records can be associated with a single " +
"response: " + records.length );
}
getHeader().setPayloadType(MsgHeader.QUERY_HIT_PAYLOAD);
remoteClientID = clientID;
destAddress = aHostAddress;
this.records = records;
this.pushProxyAddresses = pushProxyAddresses;
// when we are behind firewall or have not accepted an incoming connection
// like defined in the protocol
boolean isPushNeeded;
if ( hasConnectedIncoming )
{
isPushNeeded = false;
pushNeededFlag = QHD_FALSE_FLAG;
}
else
{
isPushNeeded = true;
pushNeededFlag = QHD_TRUE_FLAG;
}
boolean isServerBusy = isHostBusyUploading;
try
{
buildBody( speed, isPushNeeded, isServerBusy );
}
catch (IOException e)
{// should never happen
NLogger.error( QueryResponseMsg.class, e, e);
}
getHeader().setDataLength( body.length );
isParsed = true;
securityService = null;
}
/**
* <p>Create a query response with its header and body.</p>
*
* <p>The header becomes owned by this message. Its function property will
* be set to MsgHeader.sQueryResponse.</p>
*
* <p>The body is not parsed directly
* cause some queries are just forwarded without the need of beeing completely
* parsed. This allows the extention data (such as GGEP blocks) to be
* forwarded despite there being no API to modify these.</p>
*
* @param header the MsgHeader to use as header
* @throws InvalidMessageException
*/
public QueryResponseMsg( MsgHeader header, byte[] aBody, PhexSecurityManager securityService )
throws InvalidMessageException
{
super( header );
if ( header.getPayload() != MsgHeader.QUERY_HIT_PAYLOAD )
{
throw new IllegalArgumentException( "Invalid message type: " + header.getPayload() );
}
this.securityService = securityService;
body = aBody;
header.setDataLength( body.length );
// validate port
int port = IOUtil.unsignedShort2Int( IOUtil.deserializeShortLE( body, 1 ) );
destAddress = new DefaultDestAddress( getHostIP(), port );
if ( !destAddress.isValidAddress() )
{
throw new InvalidMessageException( "Invalid address: " + destAddress );
}
isParsed = false;
}
private void buildBody( int speed, boolean isPushNeeded, boolean isServerBusy )
throws IOException
{
ByteArrayOutputStream bodyStream = new ByteArrayOutputStream( );
int recordCount = records.length;
bodyStream.write( (byte) recordCount );
IOUtil.serializeShortLE( (short)destAddress.getPort(), bodyStream );
byte[] ipAddress = destAddress.getIpAddress().getHostIP();
bodyStream.write( ipAddress );
IOUtil.serializeIntLE( speed, bodyStream );
for (int i = 0; i < recordCount; i++)
{
records[ i ].write( bodyStream );
}
if ( INCLUDE_QHD )
{
// add vendor code 'PHEX'
bodyStream.write( (byte) 0x50 );
bodyStream.write( (byte) 0x48 );
bodyStream.write( (byte) 0x45 );
bodyStream.write( (byte) 0x58 );
// open data length
bodyStream.write( (byte) 2 );
// open data flags
byte isPushNeededByte = (byte) 0;
if ( isPushNeeded )
{
isPushNeededByte = PUSH_NEEDED_MASK;
}
byte isServerBusyByte = (byte) 0;
if ( isServerBusy )
{
isServerBusyByte = SERVER_BUSY_MASK;
}
byte isGGEPUsedByte = (byte)0;
if ( LibraryPrefs.AllowBrowsing.get().booleanValue()
|| ( pushProxyAddresses != null && pushProxyAddresses.length > 0 ) )
{
isGGEPUsedByte = GGEP_MASK;
}
bodyStream.write( (byte) (
isPushNeededByte
| SERVER_BUSY_MASK
| 0 //HAS_UPLOADED_MASK we dont know that yet
// we know we never measured that speed
| UPLOAD_SPEED_MASK
| GGEP_MASK ) );
bodyStream.write( (byte) (
PUSH_NEEDED_MASK
| isServerBusyByte
| 0 //(hasUploadedSuccessfully ? HAS_UPLOADED_MASK : 0)
// we know we never measured that speed
| 0 //(isSpeedMeasured ? UPLOAD_SPEED_MASK : 0));
| isGGEPUsedByte ) );
// private QHD area
// mark for chat able.
if ( NetworkPrefs.AllowChatConnection.get().booleanValue() )
{
bodyStream.write( (byte) 0x01 );
}
else
{
bodyStream.write( (byte) 0x00 );
}
//GGEP block
byte[] ggepBytes = GGEPBlock.getQueryReplyGGEPBlock(
LibraryPrefs.AllowBrowsing.get().booleanValue(), pushProxyAddresses );
if ( ggepBytes.length > 0 )
{
bodyStream.write( ggepBytes );
}
}
remoteClientID.write( bodyStream );
body = bodyStream.toByteArray();
}
/**
* <p>Get the number of response records attached to this response.</p>
*/
public short getRecordCount()
{
// instead of parsing the complete body we will only read out the
// record length. This is much more performant.
return (short)IOUtil.unsignedByte2int( body[0] );
}
/**
* The number of unique URN reuslts.
* @return the number of unique results.
* @throws InvalidMessageException
*/
public short getUniqueResultCount() throws InvalidMessageException
{
parseBody();
return uniqueResultCount;
}
/**
* Returns the IP address of the host as a byte array.
* The body is not parsed to get this data.
*/
private byte[] getHostIP()
{
byte[] ip = new byte[4];
// the ip starts at byte 3
ip[0] = body[3];
ip[1] = body[4];
ip[2] = body[5];
ip[3] = body[6];
return ip;
}
public DestAddress getDestAddress()
{
return destAddress;
}
/**
* Get the speed of the remote servent in kbyte/sec.
* @return the remote host speed
*/
public int getRemoteHostSpeed()
{
// instead of parsing the complete body we will only read out the
// record length.
long speed = IOUtil.unsignedInt2Long(
IOUtil.deserializeIntLE( body, 7 ) );
return IOUtil.castLong2Int( speed );
}
/**
* <p>If present, return the vendor code of the servent, otherwise null.</p>
*
* <p>For example, responses arrising from phex will have a vendor code of
* "PHEX".</p>
*
* @return the vendor code
* @throws InvalidMessageException
*/
public String getVendorCode() throws InvalidMessageException
{
parseBody();
return vendorCode;
}
/**
* <p>States wether the servent will require push to fetch data.</p>
*
* <p>A servent will require push if it can not accept TCP connections to
* fetch the matching resource because, for example, it is the other side of
* a fire wall.</p>
* Since this field can hold three states ( QHD_TRUE_FLAG, QHD_FALSE_FLAG,
* QHD_UNKNOWN_FLAG ) and all three states are evaluated a boolean can't be used.
*
* @return a short that will be one of the QueryConstants QHD_UNKNOWN_FLAG,
* QHD_TRUE_FLAG or QHD_FALSE_FLAG
* @throws InvalidMessageException
*/
public short getPushNeededFlag() throws InvalidMessageException
{
parseBody();
return pushNeededFlag;
}
/**
* <p>States wether the servent is currently buisy.</p>
*
* <p>A servent is buisy if all available upload slots are filled.</p>
*
* Since this field can hold three states ( QHD_TRUE_FLAG, QHD_FALSE_FLAG,
* QHD_UNKNOWN_FLAG ) and all three states are evaluated a boolean can't be used.
*
* @return a short that will be one of the QueryConstants QHD_UNKNOWN_FLAG,
* QHD_TRUE_FLAG or QHD_FALSE_FLAG
* @throws InvalidMessageException
*/
public short getServerBusyFlag() throws InvalidMessageException
{
parseBody();
return serverBusyFlag;
}
/**
* <p>States wether the servent has ever successfuly uploaded any file.</p>
*
* Since this field can hold three states ( QHD_TRUE_FLAG, QHD_FALSE_FLAG,
* QHD_UNKNOWN_FLAG ) and all three states are evaluated a boolean can't be used.
*
* @return a short that will be one of the QueryConstants QHD_UNKNOWN_FLAG,
* QHD_TRUE_FLAG or QHD_FALSE_FLAG
* @throws InvalidMessageException
*/
public short getHasUploadedFlag() throws InvalidMessageException
{
parseBody();
return hasUploadedFlag;
}
/**
* <p>States wether the servent calculates its upload speed as the highest
* average upload speed of the last 10 uploads, or as a user-defined value.
* </p>
* Since this field can hold three states ( QHD_TRUE_FLAG, QHD_FALSE_FLAG,
* QHD_UNKNOWN_FLAG ) and all three states are evaluated a boolean can't be used.
*
* @return a short that will be one of the QueryConstants QHD_UNKNOWN_FLAG,
* QHD_TRUE_FLAG or QHD_FALSE_FLAG
* @throws InvalidMessageException
*/
public short getUploadSpeedFlag() throws InvalidMessageException
{
parseBody();
return uploadSpeedFlag;
}
/**
* <p>States wether the servent supportes chat connections.</p>
*
* @return true if a servent supports chat connections false otherwise.
* @throws InvalidMessageException
*/
public boolean isChatSupported() throws InvalidMessageException
{
parseBody();
return isChatSupported;
}
/**
* <p>States wether the servent supportes browse host.</p>
*
* @return true if a servent supports browse host connections false otherwise.
* @throws InvalidMessageException
*/
public boolean isBrowseHostSupported() throws InvalidMessageException
{
parseBody();
return isBrowseHostSupported;
}
/**
* Returns the collected PushProxy addresses from the GGEP
* extension or null if no addresses are found.
* @return push proxy addresses or null.
* @throws InvalidMessageException
*/
public DestAddress[] getPushProxyAddresses() throws InvalidMessageException
{
parseBody();
return pushProxyAddresses;
}
/**
* Get the GUID of the remote servent.
*
* @return the GUID of the remote client
*/
public GUID getRemoteServentID()
{
if ( remoteClientID == null )
{
parseRemoteClientID();
}
return remoteClientID;
}
/**
* Get the i'th MsgResRecord that encapsulates the i'th hit to the query in
* this response.
*
* @throws InvalidMessageException
* @throws IndexOutOfBoundsException if i is negative or not less than
* getRecordCount()
*/
public QueryResponseRecord[] getMsgRecords( )
throws InvalidMessageException
{
parseBody();
return records;
}
/**
* Make an independent copy of a MsgQueryResponse into this message.
*
* @param b the MsgQueryResponse to copy all data from
*/
public void copy(QueryResponseMsg b)
{
getHeader().copy(b.getHeader());
destAddress = b.destAddress;
remoteClientID = b.remoteClientID;
int recordCount = b.records.length;
records = new QueryResponseRecord[ recordCount ];
for (int i = 0; i < recordCount; i++)
{
QueryResponseRecord rec = new QueryResponseRecord();
rec.copy( b.records[ i ] );
records[ i ] = rec;
}
body = b.body;
}
/**
* {@inheritDoc}
*/
@Override
public ByteBuffer createMessageBuffer()
{
return ByteBuffer.wrap( body );
}
private void parseBody( )
throws InvalidMessageException
{
if ( isParsed )
{
return;
}
assert securityService != null : "PhexSecurityService missing";
short recordCount = getRecordCount();
// skip record count -> 1
// skip port -> 2
// skip ip -> 4
// skip speed -> 4
int offset = 11;
uniqueResultCount = 0;
Set<URN> uniqueURNs = new HashSet<URN>();
records = new QueryResponseRecord[ recordCount ];
int highestAltLocCount = 0;
for (int i = 0; i < recordCount; i++)
{
QueryResponseRecord rec = new QueryResponseRecord();
offset = rec.deserialize(body, offset, securityService);
if ( rec.getAlternateLocations() != null )
{
highestAltLocCount = Math.max(highestAltLocCount,
rec.getAlternateLocations().length);
}
records[ i ] = rec;
URN urn = rec.getURN();
if ( urn != null )
{
uniqueURNs.add( urn );
}
else
{
uniqueResultCount ++;
}
}
uniqueResultCount += uniqueURNs.size();
// Handle Bearshare meta informations. The format is documented in
// the GnutellaProtocol04.pdf document
pushNeededFlag = QHD_UNKNOWN_FLAG;
serverBusyFlag = QHD_UNKNOWN_FLAG;
hasUploadedFlag = QHD_UNKNOWN_FLAG;
uploadSpeedFlag = QHD_UNKNOWN_FLAG;
// GGEP extensions
isBrowseHostSupported = false;
if ( offset <= (getHeader().getDataLength() - 16 - 4 - 2) )
{
// parse meta data
// Use ISO encoding for two bytes characters on some platforms.
try
{
vendorCode = new String( body, offset, 4, "ISO-8859-1");
}
catch ( UnsupportedEncodingException exp )
{// Should never happen...
NLogger.error( QueryResponseMsg.class, exp );
throw new RuntimeException( exp );
}
if ( isVendorCodeValid( vendorCode ) )
{
vendorCode = vendorCode.intern();
}
else
{
String hexVendorCode = HexConverter.toHexString( body, offset, 4 );
NLogger.warn(QueryResponseMsg.class,
getHeader().getFromHost() +
": Illegal QHD vendor code found: " + vendorCode + " ("
+ hexVendorCode + "). Body: " +
HexConverter.toHexString( body ) );
vendorCode = hexVendorCode;
}
offset += 4;
int openDataLength = IOUtil.unsignedByte2int( body[ offset ] );
offset += 1;
// parse upload speed, have uploaded, busy and push
if ( openDataLength > 1)
{ // if we have a flag byte
byte flag1 = body[ offset ];
byte flag2 = body[ offset + 1];
// check if push flag is meaningful do it reversed from other checks
if ( ( flag2 & PUSH_NEEDED_MASK ) != 0 )
{
if ( ( flag1 & PUSH_NEEDED_MASK ) != 0 )
{
pushNeededFlag = QHD_TRUE_FLAG;
}
else
{
pushNeededFlag = QHD_FALSE_FLAG;
}
}
// check if server busy flag meaningful
if ((flag1 & SERVER_BUSY_MASK) != 0)
{
if ( (flag2 & SERVER_BUSY_MASK) != 0 )
{
serverBusyFlag = QHD_TRUE_FLAG;
}
else
{
serverBusyFlag = QHD_FALSE_FLAG;
}
}
// check if the uploaded flag is meaningful
if ((flag1 & HAS_UPLOADED_MASK) != 0)
{
if ( (flag2 & HAS_UPLOADED_MASK) != 0 )
{
hasUploadedFlag = QHD_TRUE_FLAG;
}
else
{
hasUploadedFlag = QHD_FALSE_FLAG;
}
}
if ((flag1 & UPLOAD_SPEED_MASK) != 0 )
{
if ( (flag2 & UPLOAD_SPEED_MASK) != 0 )
{
uploadSpeedFlag = QHD_TRUE_FLAG;
}
else
{
uploadSpeedFlag = QHD_FALSE_FLAG;
}
}
if ((flag1 & GGEP_MASK) != 0 && (flag2 & GGEP_MASK) !=0 )
{// parse GGEP area should follow after open data area but
// we can't be sure...
int ggepMagicIndex = offset + 2;
// search for real magic index
while ( ggepMagicIndex < body.length )
{
if ( body[ ggepMagicIndex ] == GGEPBlock.MAGIC_NUMBER )
{
// found index!
break;
}
ggepMagicIndex ++;
}
// if there are GGEPs, see if Browse Host supported...
GGEPBlock[] ggepBlocks = GGEPBlock.parseGGEPBlocks( body, ggepMagicIndex );
isBrowseHostSupported = GGEPBlock.isExtensionHeaderInBlocks(
ggepBlocks, GGEPBlock.BROWSE_HOST_HEADER_ID );
pushProxyAddresses = GGEPExtension.parsePushProxyExtensionData( ggepBlocks, securityService );
}
}
// skip unknown open data length
offset += openDataLength;
// alt loc validation...
// Lime: 10, GTKG: 15,
int maxAcceptedAltLocs = 16;
if ( vendorCode.equals("LIME") )
{
maxAcceptedAltLocs = 10;
}
if ( highestAltLocCount > maxAcceptedAltLocs )
{
if ( NLogger.isWarnEnabled( QueryResponseMsg.class ) )
{
NLogger.warn( QueryResponseMsg.class,
"QueryRespRecord with " + highestAltLocCount + " alt locs"
+ " - vendor: " + vendorCode + " host: " + getDestAddress() + " access: "
+ securityService.controlHostAddressAccess( getDestAddress() ) );
for ( int i=0; i < records.length; i++ )
{
DestAddress[] altLocs = records[i].getAlternateLocations();
if ( altLocs != null && altLocs.length > maxAcceptedAltLocs )
{
NLogger.warn( QueryResponseMsg.class,
"QueryRespRecord with " + altLocs.length + " alt locs"
+ " - file: " + records[i].getFilename() );
}
}
if ( getHeader().getHopsTaken() <= 1 )
{
NLogger.warn( QueryResponseMsg.class,
"Number of query response record alt-locs exceed the acceptable maximum for LIME: "
+ highestAltLocCount + "/10 " +
"---- QRR Hops: " + getHeader().getHopsTaken() + " From: " + getDestAddress() );
}
}
throw new InvalidMessageException(
"Number of query response record alt-locs exceed the acceptable maximum for LIME: "
+ highestAltLocCount + "/" + 10 );
}
//Parse private area of Limewire and Shareaza to read out chat
//flag. If chatflag is 0x1 chat is supported, if 0x0 its not.
int privateDataLength = body.length - offset - 16;
if ( privateDataLength > 0 &&
( vendorCode.equals("LIME") || vendorCode.equals("RAZA")
|| vendorCode.equals("PHEX") ) )
{
byte flag = body[ offset ];
isChatSupported = ( flag & CHAT_SUPPORTED_MASK ) != 0;
}
//System.out.println( (mHeader.getDataLen() -16 - 4 -2) + " " + offset + " " +
// /*new String( body, offset, mHeader.getDataLen() - offset) + " " +*/
// openDataLength + " " + pushNeededFlag + " " + serverBusyFlag + " " +
// uploadSpeedFlag + " " + hasUploadedFlag + " " + vendorCode );
}
parseRemoteClientID();
isParsed = true;
}
private void parseRemoteClientID()
{
if ( remoteClientID == null )
{
remoteClientID = new GUID();
}
remoteClientID.deserialize(body, getHeader().getDataLength() - GUID.DATA_LENGTH);
}
private static boolean isVendorCodeValid( String vendorCode )
{
// verify length
if ( vendorCode.length() != 4 )
{
return false;
}
// verify characters
for ( int i = 0; i < 4; i++ )
{
if ( !XMLUtils.isXmlChar( vendorCode.charAt( i ) ) )
{
return false;
}
}
return true;
}
}
The table below shows all metrics for QueryResponseMsg.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 77.00 | Number of blocks | |
| BLOCK_COMMENT | 21.00 | Number of block comment lines | |
| COMMENTS | 280.00 | Comment lines | |
| COMMENT_DENSITY | 0.86 | Comment density | |
| COMPARISONS | 56.00 | Number of comparison operators | |
| CYCLOMATIC | 73.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 40.00 | Comments in declarations | |
| DOC_COMMENT | 215.00 | Number of javadoc comment lines | |
| ELOC | 324.00 | Effective lines of code | |
| EXEC_COMMENTS | 30.00 | Comments in executable code | |
| EXITS | 60.00 | Procedure exits | |
| FUNCTIONS | 23.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 89.51 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 64.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 1.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 2.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 6.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 1.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 5.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 3.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 1.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 1.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 1.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 3.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 1.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 2.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 1.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 1.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 832.00 | Number of lines in the source file | |
| LINE_COMMENT | 44.00 | Number of line comments | |
| LOC | 476.00 | Lines of code | |
| LOGICAL_LINES | 211.00 | Number of statements | |
| LOOPS | 6.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 784.00 | Number of operands | |
| OPERATORS | 1611.00 | Number of operators | |
| PARAMS | 16.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2395.00 | Halstead program length | |
| PROGRAM_VOCAB | 312.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 48.00 | Number of return points from functions | |
| SIZE | 27952.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 254.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 58.00 | Number of unique operators | |
| WHITESPACE | 76.00 | Number of whitespace lines | |