RelayRequest.java

Index Score
net.sourceforge.kolmafia.request
KoLmafia

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.

MetricDescription
COMPARISONSNumber of comparison operators
LINE_COMMENTNumber of line comments
EXITSProcedure exits
LOCLines of code
LOGICAL_LINESNumber of statements
OPERATORSNumber of operators
PROGRAM_LENGTHHalstead program length
SIZESize of the file in bytes
CYCLOMATICCyclomatic complexity
UNIQUE_OPERANDSNumber of unique operands
OPERANDSNumber of operands
EXEC_COMMENTSComments in executable code
PROGRAM_VOCABHalstead program vocabulary
ELOCEffective lines of code
LINESNumber of lines in the source file
BLOCKSNumber of blocks
JAVA0144JAVA0144 Line exceeds maximum M characters
WHITESPACENumber of whitespace lines
LOOPSNumber of loops
JAVA0145JAVA0145 Tab character used in source file
RETURNSNumber of return points from functions
JAVA0076JAVA0076 Use of magic number
JAVA0177JAVA0177 Variable declaration missing initializer
INTERFACE_COMPLEXITYInterface complexity
JAVA0117JAVA0117 Missing javadoc: method 'method'
JAVA0008JAVA0008 Empty catch block
JAVA0034JAVA0034 Missing braces in if statement
JAVA0007JAVA0007 Should not declare public field
JAVA0049JAVA0049 Nested block at depth N (maximum: M)
UNIQUE_OPERATORSNumber of unique operators
JAVA0130JAVA0130 Non-static method does not use instance fields
JAVA0116JAVA0116 Missing javadoc: field 'field'
FUNCTIONSNumber of function declarations
JAVA0166JAVA0166 Generic exception caught
JAVA0119JAVA0119 Control variable changed within body of for loop
NEST_DEPTHMaximum nesting depth
PROGRAM_VOLUMEHalstead program volume
JAVA0136JAVA0136 N methods defined in class (maximum: M)
JAVA0032JAVA0032 Switch statement missing default
JAVA0126JAVA0126 Method declares unchecked exception in throws
JAVA0110JAVA0110 Incorrect javadoc: no @return tag
JAVA0264JAVA0264 Integer math in long context - check for overflow
JAVA0108JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
DOC_COMMENTNumber of javadoc comment lines
DECL_COMMENTSComments in declarations
JAVA0075JAVA0075 Method parameter hides field
PARAMSNumber of formal parameter declarations
/** * Copyright (c) 2005-2008, KoLmafia development team * http://kolmafia.sourceforge.net/ * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * [1] Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * [2] Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * [3] Neither the name "KoLmafia" nor the names of its contributors may * be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ package net.sourceforge.kolmafia.request; import java.io.BufferedInputStream; import java.io.BufferedReader; import java.io.ByteArrayOutputStream; import java.io.File; import java.io.IOException; import java.io.InputStream; import java.io.PrintStream; import java.net.URL; import java.util.ArrayList; import java.util.Date; import java.util.List; import java.util.TreeMap; import java.util.regex.Matcher; import java.util.regex.Pattern; import net.java.dev.spellcast.utilities.DataUtilities; import net.sourceforge.kolmafia.AdventureResult; import net.sourceforge.kolmafia.AreaCombatData; import net.sourceforge.kolmafia.FamiliarData; import net.sourceforge.kolmafia.KoLAdventure; import net.sourceforge.kolmafia.KoLCharacter; import net.sourceforge.kolmafia.KoLConstants; import net.sourceforge.kolmafia.KoLmafia; import net.sourceforge.kolmafia.KoLmafiaASH; import net.sourceforge.kolmafia.KoLmafiaCLI; import net.sourceforge.kolmafia.LocalRelayServer; import net.sourceforge.kolmafia.NullStream; import net.sourceforge.kolmafia.RequestEditorKit; import net.sourceforge.kolmafia.RequestLogger; import net.sourceforge.kolmafia.RequestThread; import net.sourceforge.kolmafia.SpecialOutfit; import net.sourceforge.kolmafia.StaticEntity; import net.sourceforge.kolmafia.objectpool.ItemPool; import net.sourceforge.kolmafia.persistence.AdventureDatabase; import net.sourceforge.kolmafia.persistence.CustomItemDatabase; import net.sourceforge.kolmafia.persistence.EffectDatabase; import net.sourceforge.kolmafia.persistence.FamiliarDatabase; import net.sourceforge.kolmafia.persistence.HolidayDatabase; import net.sourceforge.kolmafia.persistence.ItemDatabase; import net.sourceforge.kolmafia.persistence.NPCStoreDatabase; import net.sourceforge.kolmafia.persistence.Preferences; import net.sourceforge.kolmafia.persistence.SkillDatabase; import net.sourceforge.kolmafia.session.ChatManager; import net.sourceforge.kolmafia.session.EquipmentManager; import net.sourceforge.kolmafia.session.InventoryManager; import net.sourceforge.kolmafia.session.SorceressLairManager; import net.sourceforge.kolmafia.session.TurnCounter; import net.sourceforge.kolmafia.swingui.AdventureFrame; import net.sourceforge.kolmafia.swingui.CommandDisplayFrame; import net.sourceforge.kolmafia.swingui.widget.ShowDescriptionList; import net.sourceforge.kolmafia.textui.DataTypes; import net.sourceforge.kolmafia.utilities.FileUtilities; import net.sourceforge.kolmafia.utilities.PauseObject; import net.sourceforge.kolmafia.utilities.StringUtilities; public class RelayRequest extends PasswordHashRequest { private final PauseObject pauser = new PauseObject(); private static final TreeMap overrideMap = new TreeMap(); private static final Pattern WHITESPACE_PATTERN = Pattern.compile( "['\\s-]" ); private static final Pattern EMAIL_PATTERN = Pattern.compile( "<table style='border: 1px solid black;' cellpadding=10>.*?</table>", Pattern.DOTALL ); private static final Pattern STORE_PATTERN = Pattern.compile( "<tr><td><input name=whichitem type=radio value=(\\d+).*?</tr>", Pattern.DOTALL ); private static final String RELAY_PATH = KoLConstants.RELAY_LOCATION.getAbsolutePath(); private static String mainpane = ""; private static KoLAdventure lastSafety = null; private final boolean allowOverride; public List headers = new ArrayList(); public byte[] rawByteBuffer = null; public String contentType = null; public String statusLine = "HTTP/1.1 302 Found"; public RelayRequest( final boolean allowOverride ) { super( "" ); this.allowOverride = allowOverride && Preferences.getBoolean( "relayAllowsOverrides" ); } public GenericRequest constructURLString( final String newURLString ) { super.constructURLString( newURLString ); this.rawByteBuffer = null; this.headers.clear(); String path = this.getPath(); if ( path.endsWith( ".css" ) ) { this.contentType = "text/css"; } else if ( path.endsWith( ".js" ) ) { this.contentType = "text/javascript"; } else if ( path.endsWith( ".gif" ) ) { this.contentType = "image/gif"; } else if ( path.endsWith( ".png" ) ) { this.contentType = "image/png"; } else if ( path.endsWith( ".jpg" ) || path.endsWith( ".jpeg" ) ) { this.contentType = "image/jpeg"; } else if ( path.endsWith( ".ico" ) ) { this.contentType = "image/x-icon"; } else if ( path.endsWith( ".php" ) || path.endsWith( ".html" ) || path.endsWith( ".ash" ) ) { this.contentType = "text/html"; } else { this.contentType = "text/plain"; } return this; } private static final boolean isJunkItem( final int itemId, final int price ) { if ( !Preferences.getBoolean( "relayHidesJunkMallItems" ) ) { return false; } if ( price > KoLCharacter.getAvailableMeat() ) { return true; } if ( NPCStoreDatabase.contains( ItemDatabase.getItemName( itemId ) ) ) { if ( price == 100 || price > ItemDatabase.getPriceById( itemId ) * 2 ) { return true; } } for ( int i = 0; i < KoLConstants.junkList.size(); ++i ) { if ( ( (AdventureResult) KoLConstants.junkList.get( i ) ).getItemId() == itemId ) { return true; } } return false; } protected boolean retryOnTimeout() { return true; } public void processResults() { if ( !this.hasNoResult() && !this.getPath().equals( "fight.php" ) ) { StaticEntity.externalUpdate( this.getURLString(), this.responseText ); } } public void formatResponse() { this.statusLine = "HTTP/1.1 200 OK"; String path = this.getPath(); StringBuffer responseBuffer = new StringBuffer( this.responseText ); // Fix KoLmafia getting outdated by events happening // in the browser by using the sidepane. if ( path.equals( "charpane.php" ) ) { CharPaneRequest.processCharacterPane( this.responseText ); } else if ( path.equals( "chatlaunch.php" ) ) { if ( Preferences.getBoolean( "relayAddsGraphicalCLI" ) ) { int linkIndex = responseBuffer.indexOf( "<a href" ); if ( linkIndex != -1 ) { responseBuffer.insert( linkIndex, "<a href=\"cli.html\"><b>KoLmafia gCLI</b></a></center><p>Type KoLmafia scripting commands in your browser!</p><center>" ); } } if ( Preferences.getBoolean( "relayAddsKoLSimulator" ) ) { int linkIndex = responseBuffer.indexOf( "<a href" ); if ( linkIndex != -1 ) { responseBuffer.insert( linkIndex, "<a href=\"simulator/index.html\" target=\"_blank\"><b>KoL Simulator</b></a></center><p>See what might happen before it happens!</p><center>" ); } } } // Fix it a little more by making sure that familiar // changes and equipment changes are remembered. else if ( path.equals( "main.php" ) ) { Matcher emailMatcher = RelayRequest.EMAIL_PATTERN.matcher( this.responseText ); if ( emailMatcher.find() ) { responseBuffer = new StringBuffer( emailMatcher.replaceAll( "" ) ); } } // If this is a store, you can opt to remove all the min-priced items from view // along with all the items which are priced above affordable levels. else if ( path.equals( "mallstore.php" ) ) { int searchItemId = -1; int searchPrice = -1; searchItemId = StringUtilities.parseInt( this.getFormField( "searchitem" ) ); searchPrice = StringUtilities.parseInt( this.getFormField( "searchprice" ) ); Matcher itemMatcher = RelayRequest.STORE_PATTERN.matcher( this.responseText ); while ( itemMatcher.find() ) { String itemData = itemMatcher.group( 1 ); int itemId = StringUtilities.parseInt( itemData.substring( 0, itemData.length() - 9 ) ); int price = StringUtilities.parseInt( itemData.substring( itemData.length() - 9 ) ); if ( itemId != searchItemId && RelayRequest.isJunkItem( itemId, price ) ) { StringUtilities.singleStringDelete( responseBuffer, itemMatcher.group() ); } } // Also make sure the item that the person selected when coming into the // store is pre-selected. if ( searchItemId != -1 ) { String searchString = MallPurchaseRequest.getStoreString( searchItemId, searchPrice ); StringUtilities.singleStringReplace( responseBuffer, "value=" + searchString, "checked value=" + searchString ); } } else if ( path.equals( "fight.php" ) ) { String action = this.getFormField( "action" ); if ( action != null && action.equals( "skill" ) ) { String skillId = this.getFormField( "whichskill" ); if ( skillId != null && !skillId.equals( "none" ) && !skillId.equals( "3004" ) ) { String testAction; int maximumIndex = KoLConstants.STATIONARY_BUTTON_COUNT + 1; int insertIndex = maximumIndex; for ( int i = 1; i <= KoLConstants.STATIONARY_BUTTON_COUNT && insertIndex == maximumIndex; ++i ) { testAction = Preferences.getString( "stationaryButton" + i ); if ( testAction.equals( "" ) || testAction.equals( "none" ) || testAction.equals( skillId ) ) { insertIndex = i; } } if ( insertIndex == maximumIndex ) { insertIndex = KoLConstants.STATIONARY_BUTTON_COUNT; for ( int i = 2; i <= KoLConstants.STATIONARY_BUTTON_COUNT; ++i ) { Preferences.setString( "stationaryButton" + ( i - 1 ), Preferences.getString( "stationaryButton" + i ) ); } } Preferences.setString( "stationaryButton" + insertIndex, skillId ); } } } try { RequestEditorKit.getFeatureRichHTML( this.getURLString(), responseBuffer, true ); } catch ( Exception e ) { StaticEntity.printStackTrace( e ); } // Load image files locally to reduce bandwidth // and improve mini-browser performance. if ( Preferences.getBoolean( "relayUsesCachedImages" ) ) { StringUtilities.globalStringReplace( responseBuffer, "http://images.kingdomofloathing.com", "/images" ); } else { StringUtilities.globalStringReplace( responseBuffer, "http://images.kingdomofloathing.com/scripts", "/images/scripts" ); } // Download and link to any Players of Loathing // picture pages locally. StringUtilities.globalStringReplace( responseBuffer, "http://pics.communityofloathing.com/albums", "/images" ); // Remove the default frame busting script so that // we can detach user interface elements. StringUtilities.singleStringReplace( responseBuffer, "frames.length == 0", "frames.length == -1" ); StringUtilities.globalStringReplace( responseBuffer, " name=adv ", " name=snarfblat " ); this.responseText = responseBuffer.toString(); CustomItemDatabase.linkCustomItem( this ); } public void printHeaders( final PrintStream ostream ) { if ( !this.headers.isEmpty() ) { for ( int i = 0; i < this.headers.size(); ++i ) { ostream.println( this.headers.get( i ) ); } } else { String header; for ( int i = 0; ( header = this.formConnection.getHeaderFieldKey( i ) ) != null; ++i ) { if ( header.startsWith( "Content" ) || header.startsWith( "Cache" ) || header.equals( "Pragma" ) || header.equals( "Set-Cookie" ) ) { continue; } ostream.print( header ); ostream.print( ": " ); ostream.println( this.formConnection.getHeaderField( i ) ); } if ( this.responseCode == 200 && this.rawByteBuffer != null ) { ostream.print( "Content-Type: " ); ostream.print( this.contentType ); if ( this.contentType.startsWith( "text" ) ) { ostream.print( "; charset=UTF-8" ); } ostream.println(); ostream.print( "Content-Length: " ); ostream.print( this.rawByteBuffer.length ); ostream.println(); ostream.println( "Cache-Control: no-cache, must-revalidate" ); ostream.println( "Pragma: no-cache" ); } } } public void pseudoResponse( final String status, final String responseText ) { this.statusLine = status; this.headers.add( "Date: " + new Date() ); this.headers.add( "Server: " + KoLConstants.VERSION_NAME ); if ( status.indexOf( "302" ) != -1 ) { this.headers.add( "Location: " + responseText ); this.responseCode = 302; this.responseText = ""; } else if ( status.indexOf( "200" ) != -1 ) { this.responseCode = 200; if ( responseText.length() == 0 ) { this.responseText = " "; } else { this.rawByteBuffer = null; this.responseText = responseText; } if ( this.contentType.equals( "text/html" ) ) { this.headers.add( "Content-Type: text/html; charset=UTF-8" ); this.headers.add( "Cache-Control: no-cache, must-revalidate" ); this.headers.add( "Pragma: no-cache" ); } else { this.headers.add( "Content-Type: " + this.contentType ); } } else { this.responseText = " "; } this.headers.add( "Connection: close" ); } private StringBuffer readContents( final BufferedReader reader ) { String line = null; StringBuffer contentBuffer = new StringBuffer(); try { if ( reader == null ) { return contentBuffer; } while ( ( line = reader.readLine() ) != null ) { contentBuffer.append( line ); contentBuffer.append( KoLConstants.LINE_BREAK ); } reader.close(); } catch ( IOException e ) { } return contentBuffer; } private void sendLocalImage( final String filename ) { URL imageURL = FileUtilities.downloadImage( "http://images.kingdomofloathing.com" + filename.substring( 6 ) ); if ( imageURL == null ) { this.sendNotFound(); return; } InputStream istream; try { istream = imageURL.openConnection().getInputStream(); } catch ( IOException e ) { this.sendNotFound(); return; } ByteArrayOutputStream outbytes = new ByteArrayOutputStream( 4096 ); BufferedInputStream bufferedIstream = new BufferedInputStream( istream ); try { byte[] buffer = new byte[ 4096 ]; int offset; while ( ( offset = bufferedIstream.read( buffer ) ) > 0 ) { outbytes.write( buffer, 0, offset ); } } catch ( IOException e ) { } try { bufferedIstream.close(); } catch ( IOException e ) { } try { outbytes.flush(); } catch ( IOException e ) { } this.rawByteBuffer = outbytes.toByteArray(); this.pseudoResponse( "HTTP/1.1 200 OK", "" ); } public static final void setNextMain( final String mainpane ) { RelayRequest.mainpane = mainpane; } private void handleMain() { if ( this.responseText == null ) { super.run(); } if ( RelayRequest.mainpane.equals( "" ) ) { return; } // If it's a relay browser request based on a // menu item, then change the middle panel. this.responseText = RelayRequest.MAINPANE_PATTERN.matcher( this.responseText ).replaceFirst( "name=mainpane src=\"" + RelayRequest.mainpane + "\"" ); RelayRequest.mainpane = ""; } private static final Pattern MAINPANE_PATTERN = Pattern.compile( "name=mainpane src=\"(.*?)\"", Pattern.DOTALL ); private void sendLocalFile( final String filename ) { StringBuffer replyBuffer = new StringBuffer(); if ( !RelayRequest.overrideMap.containsKey( filename ) ) { RelayRequest.overrideMap.put( filename, new File( KoLConstants.RELAY_LOCATION, filename ) ); } File override = (File) RelayRequest.overrideMap.get( filename ); if ( !override.getAbsolutePath().startsWith( RELAY_PATH ) ) { this.sendNotFound(); return; } if ( !override.exists() ) { if ( filename.equals( "main.html" ) || filename.equals( "main_c.html" ) ) { this.handleMain(); return; } if ( !filename.startsWith( "simulator/" ) ) { this.sendNotFound(); return; } this.downloadSimulatorFile( filename.substring( filename.lastIndexOf( "/" ) + 1 ) ); } replyBuffer = this.readContents( DataUtilities.getReader( override ) ); // Add Javascript to the KoL simulator pages so that // everything loads correctly the first time. if ( filename.endsWith( "simulator/index.html" ) ) { this.handleSimulatorIndex( replyBuffer ); } if ( filename.equals( "chat.html" ) ) { StringUtilities.singleStringReplace( replyBuffer, "CHATAUTH", "playerid=" + KoLCharacter.getPlayerId() + "&pwd=" + GenericRequest.passwordHash ); } StringUtilities.globalStringReplace( replyBuffer, "MAFIAHIT", "pwd=" + GenericRequest.passwordHash ); // Make sure to print the reply buffer to the // response buffer for the local relay server. if ( this.isChatRequest ) { StringUtilities.globalStringReplace( replyBuffer, "<br>", "</font><br>" ); } if ( filename.endsWith( "chat.html" ) ) { RequestEditorKit.addChatFeatures( replyBuffer ); } this.pseudoResponse( "HTTP/1.1 200 OK", replyBuffer.toString() ); if ( filename.equals( "main.html" ) || filename.equals( "main_c.html" ) ) { this.handleMain(); return; } } private static final String getSimulatorEffectName( final String effectName ) { return RelayRequest.WHITESPACE_PATTERN.matcher( effectName ).replaceAll( "" ).toLowerCase(); } private static final String getSimulatorEquipName( final int equipmentSlot ) { AdventureResult item = EquipmentManager.getEquipment( equipmentSlot ); if ( equipmentSlot == EquipmentManager.FAMILIAR && item.getName().equals( FamiliarDatabase.getFamiliarItem( KoLCharacter.getFamiliar().getId() ) ) ) { return "familiar-specific +5 lbs."; } if ( item == EquipmentRequest.UNEQUIP ) { return "(None)"; } return item.getName(); } private void handleSimulatorIndex( final StringBuffer replyBuffer ) { StringBuffer scriptBuffer = new StringBuffer(); scriptBuffer.append( KoLConstants.LINE_BREAK ); scriptBuffer.append( "<script language=\"Javascript\">" ); scriptBuffer.append( KoLConstants.LINE_BREAK ); scriptBuffer.append( KoLConstants.LINE_BREAK ); scriptBuffer.append( "LoadKingdomStateLong( { " ); // This is the simple Javascript which can be added // arbitrarily to the end without having to modify // the underlying HTML. int classIndex = -1; for ( int i = 0; i < DataTypes.CLASSES.length; ++i ) { if ( DataTypes.CLASSES[ i ].equalsIgnoreCase( KoLCharacter.getClassType() ) ) { classIndex = i; } } // Player state scriptBuffer.append( "charclass: " ); scriptBuffer.append( classIndex ); scriptBuffer.append( ", mus: " ); scriptBuffer.append( KoLCharacter.getBaseMuscle() ); scriptBuffer.append( ", mys: " ); scriptBuffer.append( KoLCharacter.getBaseMysticality() ); scriptBuffer.append( ", mox: " ); scriptBuffer.append( KoLCharacter.getBaseMoxie() ); scriptBuffer.append( ", " ); // Current equipment scriptBuffer.append( "hat: \"" ); scriptBuffer.append( RelayRequest.getSimulatorEquipName( EquipmentManager.HAT ) ); scriptBuffer.append( "\", weapon: \"" ); scriptBuffer.append( RelayRequest.getSimulatorEquipName( EquipmentManager.WEAPON ) ); scriptBuffer.append( "\", offhand: \"" ); scriptBuffer.append( RelayRequest.getSimulatorEquipName( EquipmentManager.OFFHAND ) ); scriptBuffer.append( "\", shirt: \"" ); scriptBuffer.append( RelayRequest.getSimulatorEquipName( EquipmentManager.SHIRT ) ); scriptBuffer.append( "\", pants: \"" ); scriptBuffer.append( RelayRequest.getSimulatorEquipName( EquipmentManager.PANTS ) ); scriptBuffer.append( "\", acc1: \"" ); scriptBuffer.append( RelayRequest.getSimulatorEquipName( EquipmentManager.ACCESSORY1 ) ); scriptBuffer.append( "\", acc2: \"" ); scriptBuffer.append( RelayRequest.getSimulatorEquipName( EquipmentManager.ACCESSORY2 ) ); scriptBuffer.append( "\", acc3: \"" ); scriptBuffer.append( RelayRequest.getSimulatorEquipName( EquipmentManager.ACCESSORY3 ) ); scriptBuffer.append( "\", " ); // Current familiar scriptBuffer.append( "familiar: \"" ); scriptBuffer.append( KoLCharacter.getFamiliar().getRace() ); scriptBuffer.append( "\", weight: " ); scriptBuffer.append( KoLCharacter.getFamiliar().getWeight() ); scriptBuffer.append( ", fameq: \"" ); String familiarEquipment = RelayRequest.getSimulatorEquipName( EquipmentManager.FAMILIAR ); if ( FamiliarData.itemWeightModifier( ItemDatabase.getItemId( familiarEquipment ) ) == 5 ) { scriptBuffer.append( "familiar-specific +5 lbs." ); } else { scriptBuffer.append( familiarEquipment ); } // Status effects scriptBuffer.append( "\", rockandroll: false, effects: [ " ); int effectCount = 0; for ( int i = 0; i < KoLConstants.availableSkills.size(); ++i ) { UseSkillRequest current = (UseSkillRequest) KoLConstants.availableSkills.get( i ); int skillId = current.getSkillId(); if ( SkillDatabase.getSkillType( skillId ) != SkillDatabase.PASSIVE ) { continue; } if ( effectCount > 0 ) { scriptBuffer.append( ',' ); } ++effectCount; scriptBuffer.append( '\"' ); scriptBuffer.append( RelayRequest.getSimulatorEffectName( current.getSkillName() ) ); scriptBuffer.append( '\"' ); } for ( int i = 0; i < KoLConstants.activeEffects.size(); ++i ) { AdventureResult current = (AdventureResult) KoLConstants.activeEffects.get( i ); if ( effectCount > 0 ) { scriptBuffer.append( ',' ); } ++effectCount; scriptBuffer.append( '\"' ); scriptBuffer.append( RelayRequest.getSimulatorEffectName( current.getName() ) ); scriptBuffer.append( '\"' ); } scriptBuffer.append( " ], " ); // Adventure modifiers scriptBuffer.append( "zone: \"" ); scriptBuffer.append( Preferences.getString( "lastAdventure" ) ); scriptBuffer.append( "\", monster: \"" ); scriptBuffer.append( FightRequest.getCurrentKey() ); scriptBuffer.append( "\", mcd: " ); scriptBuffer.append( KoLCharacter.getMindControlLevel() ); scriptBuffer.append( ", " ); scriptBuffer.append( "moonphase: " ); scriptBuffer.append( (int) ( ( HolidayDatabase.getGrimacePhase() - 1 ) * 2 + Math.round( ( HolidayDatabase.getRonaldPhase() - 1 ) / 2.0f - Math.floor( ( HolidayDatabase.getRonaldPhase() - 1 ) / 2.0f ) ) ) ); scriptBuffer.append( ", moonminiphase: " ); scriptBuffer.append( HolidayDatabase.getHamburglarPosition( new Date() ) ); scriptBuffer.append( " } );" ); scriptBuffer.append( KoLConstants.LINE_BREAK ); scriptBuffer.append( KoLConstants.LINE_BREAK ); scriptBuffer.append( "</script>" ); this.insertAfterEnd( replyBuffer, scriptBuffer.toString() ); } public void insertAfterEnd( final StringBuffer replyBuffer, final String contents ) { int terminalIndex = replyBuffer.lastIndexOf( "</html>" ); if ( terminalIndex == -1 ) { replyBuffer.append( contents ); replyBuffer.append( "</html>" ); } else { replyBuffer.insert( terminalIndex, contents ); } } public void sendNotFound() { this.pseudoResponse( "HTTP/1.1 404 Not Found", "" ); this.responseCode = 404; } public void sendBossWarning( final String name, final String image, final int mcd1, final String item1, final int mcd2, final String item2 ) { int mcd0 = KoLCharacter.getMindControlLevel(); StringBuffer warning = new StringBuffer(); warning.append( "<html><head><script language=Javascript src=\"/basics.js\"></script>" ); warning.append( "<script language=Javascript> " ); warning.append( "var default0 = " + mcd0 + "; " ); warning.append( "var default1 = " + mcd1 + "; " ); warning.append( "var default2 = " + mcd2 + "; " ); warning.append( "var current = " + mcd0 + "; " ); warning.append( "function switchLinks( id ) { " ); warning.append( "if ( id == \"mcd1\" ) { " ); warning.append( "current = (current == default0) ? default1 : default0; " ); warning.append( "} else { " ); warning.append( "current = (current == default0) ? default2 : default0; " ); warning.append( "} " ); warning.append( "getObject(\"mcd1\").style.border = (current == default1) ? \"1px dashed blue\" : \"1px dashed white\"; " ); warning.append( "getObject(\"mcd2\").style.border = (current == default2) ? \"1px dashed blue\" : \"1px dashed white\"; " ); warning.append( "top.charpane.location.href = \"/KoLmafia/sideCommand?cmd=mcd+\" + current + \"&pwd=" ); warning.append( GenericRequest.passwordHash ); warning.append( "\"; } </script>" ); warning.append( "<link rel=\"stylesheet\" type=\"text/css\" href=\"http://images.kingdomofloathing.com/styles.css\"></head>" ); warning.append( "<body><center><table width=95% cellspacing=0 cellpadding=0><tr><td style=\"color: white;\" align=center bgcolor=blue><b>Results:</b></td></tr><tr><td style=\"padding: 5px; border: 1px solid blue;\"><center><table><tr><td><center>" ); warning.append( "<table><tr>" ); warning.append( "<td align=center valign=center><div id=\"mcd1\" style=\"padding: 4px 4px 4px 4px" ); if ( mcd0 == mcd1 ) { warning.append( "; border: 1px dashed blue" ); } warning.append( "\"><a id=\"link1\" style=\"text-decoration: none\" onClick=\"switchLinks('mcd1'); void(0);\" href=\"#\"><img src=\"http://images.kingdomofloathing.com/itemimages/" ); warning.append( item1 ); warning.append( "\" width=30 height=30><br /><font size=1>MCD " ); warning.append( mcd1 ); warning.append( "</font></a></div></td>" ); warning.append( "<td>&nbsp;&nbsp;&nbsp;&nbsp;</td>" ); warning.append( "<td valign=center><a href=\"" ); warning.append( this.getURLString() ); warning.append( "&confirm=on" ); warning.append( "\"><img src=\"http://images.kingdomofloathing.com/adventureimages/" ); warning.append( image ); warning.append( "\"></a></td>" ); warning.append( "<td>&nbsp;&nbsp;&nbsp;&nbsp;</td>" ); warning.append( "<td align=center valign=center><div id=\"mcd2\" style=\"padding: 4px 4px 4px 4px" ); if ( KoLCharacter.getMindControlLevel() == mcd2 ) { warning.append( "; border: 1px dashed blue" ); } warning.append( "\"><a id=\"link2\" style=\"text-decoration: none\" onClick=\"switchLinks('mcd2'); void(0);\" href=\"#\"><img src=\"http://images.kingdomofloathing.com/itemimages/" ); warning.append( item2 ); warning.append( "\" width=30 height=30><br /><font size=1>MCD " ); warning.append( mcd2 ); warning.append( "</font></a></div></td>" ); warning.append( "</tr></table></center><blockquote>The " ); warning.append( name ); warning.append( " drops special rewards based on your mind-control level. If you'd like a special reward, click on one of the items above to set your mind-control device appropriately. Click on it again to reset the MCD back to your old setting. Click on the " ); warning.append( name ); warning.append( " once you've decided to proceed.</blockquote></td></tr></table></center></td></tr></table></center></body></html>" ); this.pseudoResponse( "HTTP/1.1 200 OK", warning.toString() ); } public void sendGeneralWarning( final String image, final String message ) { StringBuffer warning = new StringBuffer(); warning.append( "<html><head><link rel=\"stylesheet\" type=\"text/css\" href=\"http://images.kingdomofloathing.com/styles.css\"><script language=\"Javascript\" src=\"/basics.js\"></script></head><body><center><table width=95% cellspacing=0 cellpadding=0><tr><td style=\"color: white;\" align=center bgcolor=blue><b>Results:</b></td></tr><tr><td style=\"padding: 5px; border: 1px solid blue;\"><center><table><tr><td>" ); if ( image != null && !image.equals( "" ) ) { String url = this.getURLString(); warning.append( "<center><a href=\"" ); warning.append( url ); warning.append( url.indexOf( "?" ) == -1 ? "?" : "&" ); warning.append( "confirm=on\"><img id=\"warningImage\" src=\"http://images.kingdomofloathing.com/itemimages/" ); warning.append( image ); warning.append( "\" width=30 height=30></a><br></center>" ); } warning.append( "<blockquote>" ); warning.append( message ); warning.append( "</blockquote></td></tr></table></center></td></tr></table></center></body></html>" ); this.pseudoResponse( "HTTP/1.1 200 OK", warning.toString() ); } public void sendCloverWarning() { StringBuffer warning = new StringBuffer(); warning.append( "<html><head><script language=Javascript src=\"/basics.js\"></script>" ); warning.append( "<link rel=\"stylesheet\" type=\"text/css\" href=\"http://images.kingdomofloathing.com/styles.css\"></head>" ); warning.append( "<body><center><table width=95% cellspacing=0 cellpadding=0><tr><td style=\"color: white;\" align=center bgcolor=blue><b>Results:</b></td></tr><tr><td style=\"padding: 5px; border: 1px solid blue;\"><center><table><tr><td><center>" ); warning.append( "<table><tr>" ); String url = this.getURLString(); warning.append( "<td align=center valign=center><div id=\"lucky\" style=\"padding: 4px 4px 4px 4px\"><a style=\"text-decoration: none\" href=\"" ); warning.append( url ); warning.append( url.indexOf( "?" ) == -1 ? "?" : "&" ); warning.append( "confirm=on\"><img src=\"http://images.kingdomofloathing.com/itemimages/clover.gif\" width=30 height=30 border=0>" ); warning.append( "</a></div></td>" ); warning.append( "<td>&nbsp;&nbsp;&nbsp;&nbsp;</td>" ); warning.append( "<td align=center valign=center><div id=\"unlucky\" style=\"padding: 4px 4px 4px 4px\"><a style=\"text-decoration: none\" href=\"#\" onClick=\"multiUse('multiuse.php', " ); warning.append( ItemPool.TEN_LEAF_CLOVER ); warning.append( ", " ); warning.append( InventoryManager.getCount( ItemPool.TEN_LEAF_CLOVER ) ); warning.append( "); void(0);\"><img src=\"http://images.kingdomofloathing.com/itemimages/disclover.gif\" width=30 height=30 border=0>" ); warning.append( "</a></div></td>" ); warning.append( "</tr></table></center><blockquote>KoLmafia has detected a ten-leaf clover in your inventory. If you are sure you wish to use it, click on the assembled clover on the left. If this was an accident, please click on the disassembled clover on the right to disassemble your clovers first. To disable this warning, please check your preferences and disable clover protection.</blockquote></td></tr></table></center></td></tr></table></center></body></html>" ); this.pseudoResponse( "HTTP/1.1 200 OK", warning.toString() ); } private void handleSafety() { if ( RelayRequest.lastSafety == null ) { this.pseudoResponse( "HTTP/1.1 200 OK", "" ); return; } AreaCombatData combat = RelayRequest.lastSafety.getAreaSummary(); if ( combat == null ) { this.pseudoResponse( "HTTP/1.1 200 OK", "" ); return; } StringBuffer buffer = new StringBuffer(); buffer.append( "<table width=\"100%\"><tr><td align=left valign=top><font size=3>" ); buffer.append( RelayRequest.lastSafety.getAdventureName() ); buffer.append( "</font></td><td align=right valign=top><font size=2>" ); buffer.append( "<a style=\"text-decoration: none\" href=\"javascript: " ); buffer.append( "var safety; if ( document.getElementById ) " ); buffer.append( "safety = top.chatpane.document.getElementById( 'safety' ); " ); buffer.append( "else if ( document.all ) " ); buffer.append( "safety = top.chatpane.document.all[ 'safety' ]; " ); buffer.append( "safety.closed = true;" ); buffer.append( "safety.active = false;" ); buffer.append( "safety.style.display = 'none'; " ); buffer.append( "var nodes = top.chatpane.document.body.childNodes; " ); buffer.append( "for ( var i = 0; i < nodes.length; ++i ) " ); buffer.append( "if ( nodes[i].style && nodes[i].id != 'safety' ) " ); buffer.append( "nodes[i].style.display = nodes[i].unsafety; " ); buffer.append( "void(0);\">x</a></font></td></tr></table>" ); buffer.append( "<br/><font size=2>" ); String combatData = combat.toString( true ); combatData = combatData.substring( 6, combatData.length() - 7 ); buffer.append( combatData ); buffer.append( "</font>" ); this.pseudoResponse( "HTTP/1.1 200 OK", buffer.toString() ); } private void handleCommand() { // None of the above checks wound up happening. So, do some // special handling, catching any exceptions that happen to // popup along the way. if ( this.getPath().endsWith( "submitCommand" ) ) { submitCommand( this.getFormField( "cmd" ) ); this.pseudoResponse( "HTTP/1.1 200 OK", "" ); } else if ( this.getPath().endsWith( "executeCommand" ) ) { submitCommand( this.getFormField( "cmd" ) ); this.pseudoResponse( "HTTP/1.1 200 OK", "" ); } else if ( this.getPath().endsWith( "sideCommand" ) ) { submitCommand( this.getFormField( "cmd" ) ); this.pseudoResponse( "HTTP/1.1 302 Found", "/charpane.php" ); } else if ( this.getPath().endsWith( "messageUpdate" ) ) { this.pseudoResponse( "HTTP/1.1 200 OK", LocalRelayServer.getNewStatusMessages() ); } else if ( this.getPath().endsWith( "lookupLocation" ) ) { RelayRequest.lastSafety = AdventureDatabase.getAdventureByURL( "adventure.php?snarfblat=" + this.getFormField( "snarfblat" ) ); AdventureFrame.updateSelectedAdventure( RelayRequest.lastSafety ); this.handleSafety(); } else if ( this.getPath().endsWith( "updateLocation" ) ) { this.handleSafety(); } else { this.pseudoResponse( "HTTP/1.1 200 OK", "" ); } } private void submitCommand( String command ) { CommandDisplayFrame.executeCommand( command ); while ( CommandDisplayFrame.hasQueuedCommands() ) { this.pauser.pause( 500 ); } } private void handleChat() { // If you are in chat, and the person submitted a command // via chat, check to see if it's a CLI command. Otherwise, // run it as normal. String chatResponse = ChatRequest.executeChatCommand( this.getFormField( "graf" ), false ); if ( chatResponse != null ) { this.pseudoResponse( "HTTP/1.1 200 OK", "<font color=\"blue\"><b><a target=\"mainpane\" href=\"showplayer.php?who=458968\" style=\"color:blue\">" + KoLConstants.VERSION_NAME + "</a> (private)</b>: " + chatResponse + "</font><br>" ); return; } super.run(); if ( !ChatManager.isRunning() || this.getPath().indexOf( "submitnewchat.php" ) != -1 ) { ChatManager.updateChat( this.responseText ); } if ( Preferences.getBoolean( "relayFormatsChatText" ) ) { this.responseText = ChatManager.getNormalizedContent( this.responseText, false ); } } public void handleSimple() { // If there is an attempt to view the error page, or if // there is an attempt to view the robots file, neither // are available on KoL, so return. if ( this.getPath().equals( "missingimage.gif" ) || this.getPath().endsWith( "robots.txt" ) || this.getPath().endsWith( "favicon.ico" ) ) { this.sendNotFound(); return; } // If this is a command from the browser, handle it before // moving on to anything else. if ( this.getPath().startsWith( "KoLmafia/" ) ) { this.handleCommand(); return; } // Check to see if it's a request from the local images folder. // If it is, go ahead and send it. if ( this.getPath().startsWith( "images/playerpics/" ) ) { FileUtilities.downloadImage( "http://pics.communityofloathing.com/albums/" + this.getPath().substring( this.getPath().indexOf( "playerpics" ) ) ); this.sendLocalImage( this.getPath() ); return; } if ( this.getPath().startsWith( "images/" ) ) { this.sendLocalImage( this.getPath() ); return; } // If it's an ASH override script, make sure to handle it // exactly as it should. if ( this.getPath().endsWith( ".ash" ) ) { if ( !KoLmafiaASH.getClientHTML( this ) ) { this.sendNotFound(); } return; } // Local files never have form fields. Remove them, because // they're probably just used for data tracking purposes // client-side. this.data.clear(); this.sendLocalFile( this.getPath() ); } public void run() { if ( this.getPath().startsWith( "http" ) ) { super.run(); return; } if ( !this.getPath().endsWith( ".php" ) ) { this.handleSimple(); return; } // If it's a chat request, handle it right away and return. // Otherwise, continue on. if ( this.isChatRequest ) { this.handleChat(); return; } // If it gets this far, consider firing a relay browser // override for it. if ( this.allowOverride && KoLmafiaASH.getClientHTML( this ) ) { return; } if ( this.getPath().equals( "lchat.php" ) ) { if ( Preferences.getBoolean( "relayUsesIntegratedChat" ) ) { this.sendLocalFile( "chat.html" ); return; } super.run(); this.responseText = StringUtilities.globalStringReplace( this.responseText, "<p>", "<br><br>" ); this.responseText = StringUtilities.globalStringReplace( this.responseText, "<P>", "<br><br>" ); this.responseText = StringUtilities.singleStringDelete( this.responseText, "</span>" ); return; } // Load custom items from OneTonTomato's script if they // are currently being requested. if ( this.getPath().equals( "desc_item.php" ) ) { String item = this.getFormField( "whichitem" ); if ( item != null && item.startsWith( "custom" ) ) { this.pseudoResponse( "HTTP/1.1 200 OK", CustomItemDatabase.retrieveCustomItem( item.substring( 6 ) ) ); return; } if ( showWikiLink( item ) ) { String location = ShowDescriptionList.getWikiLocation( ItemDatabase.getItemName( item ) ); if ( location != null ) { this.pseudoResponse( "HTTP/1.1 302 Found", location ); return; } } } TurnCounter expired = TurnCounter.getExpiredCounter( this ); if ( expired != null ) { this.sendGeneralWarning( expired.getImage(), "The indicated counter has expired, so may wish to adventure somewhere else at this time. If you are certain that this is where you'd like to adventure, click on the image to proceed." ); return; } String path = this.getPath(); String urlString = this.getURLString(); if ( path.equals( "desc_effect.php" ) && Preferences.getBoolean( "relayAddsWikiLinks" ) ) { String effect = this.getFormField( "whicheffect" ); String location = ShowDescriptionList.getWikiLocation( new AdventureResult( EffectDatabase.getEffectName( effect ), 1, true ) ); if ( location != null ) { this.pseudoResponse( "HTTP/1.1 302 Found", location ); return; } } KoLAdventure adventure = AdventureDatabase.getAdventureByURL( urlString ); String adventureName = adventure != null ? adventure.getAdventureName() : AdventureDatabase.getUnknownName( urlString ); if ( adventureName != null && this.getFormField( "confirm" ) == null ) { // Wait until any restoration scripts finish running before // allowing an adventuring request to continue. while ( KoLmafia.isRunningBetweenBattleChecks() ) { this.pauser.pause( 200 ); } // Check for clovers as well so that people don't accidentally // use up a clover in the middle of a bad moon run. if ( AdventureDatabase.isPotentialCloverAdventure( adventureName ) && Preferences.getBoolean( "cloverProtectActive" ) ) { this.sendCloverWarning(); return; } // Special handling of adventuring locations before it's // registered internally with KoLmafia. // Sometimes, people want the MCD rewards from various // boss monsters. Let's help out. if ( path.equals( "adventure.php" ) ) { String location = adventure == null ? null : adventure.getAdventureId(); // This one's for the Boss Bat, who has special // items at 4 and 8. if ( location != null && location.equals( "34" ) && !KoLCharacter.inBadMoon() ) { this.sendBossWarning( "Boss Bat", "bossbat.gif", 4, "batpants.gif", 8, "batbling.gif" ); return; } } // More MCD rewards. This one is for the Knob Goblin // King, who has special items at 3 and 7. else if ( path.equals( "knob.php" ) ) { if ( this.getFormField( "king" ) != null && !KoLCharacter.inBadMoon() ) { this.sendBossWarning( "Knob Goblin King", "goblinking.gif", 3, "glassballs.gif", 7, "batcape.gif" ); return; } } // More MCD rewards. This one is for the Bonerdagon, // who has special items at 5 and 10. else if ( path.equals( "cyrpt.php" ) ) { if ( this.getFormField( "action" ) != null && !KoLCharacter.inBadMoon() ) { this.sendBossWarning( "Bonerdagon", "bonedragon.gif", 5, "rib.gif", 10, "vertebra.gif" ); return; } } } // If the person is visiting the sorceress and they forgot // to make the Wand, remind them. else if ( path.equals( "lair6.php" ) ) { // As of NS 13,they need not have it equipped. In fact, // there are far better weapons to equip for the // battle. But, just in case, check current equipment // as well as inventory. String place = this.getFormField( "place" ); if ( place != null ) { if ( place.equals( "5" ) && !KoLCharacter.hasEquipped( SorceressLairManager.NAGAMAR ) && !InventoryManager.retrieveItem( SorceressLairManager.NAGAMAR ) ) { this.sendGeneralWarning( "wand.gif", "It's possible there is something very important you're forgetting to do." ); return; } if ( place.equals( "6" ) && KoLCharacter.isHardcore() && Preferences.getBoolean( "lucreCoreLeaderboard" ) ) { int lucreCount = InventoryManager.getCount( ItemPool.LUCRE ); if ( lucreCount > 0 ) { new DisplayCaseRequest( new Object[] { ItemPool.get( ItemPool.LUCRE, lucreCount ) }, true ).run(); new SendMailRequest( "koldbot", "Completed ascension." ).run(); } this.sendGeneralWarning( "lucre.gif", "Click on the lucre if you've already received koldbot's confirmation message." ); return; } } } else if ( path.equals( "ascend.php" ) ) { if ( this.getFormField( "action" ) != null ) { RequestThread.postRequest( new EquipmentRequest( SpecialOutfit.BIRTHDAY_SUIT ) ); } } // If it gets this far, it's a normal file. Go ahead and // process it accordingly. super.run(); if ( this.responseCode == 302 ) { this.pseudoResponse( "HTTP/1.1 302 Found", this.redirectLocation ); } else if ( this.responseCode != 200 ) { this.sendNotFound(); } return; } private static boolean showWikiLink( final String item ) { if ( !Preferences.getBoolean( "relayAddsWikiLinks" ) ) return false; switch ( ItemDatabase.getItemIdFromDescription( item ) ) { case 2271: // dusty bottle of Merlot case 2272: // dusty bottle of Port case 2273: // dusty bottle of Pinot Noir case 2274: // dusty bottle of Zinfandel case 2275: // dusty bottle of Marsala case 2276: // dusty bottle of Muscat return false; } return true; } private void downloadSimulatorFile( final String filename ) { try { BufferedReader reader = DataUtilities.getReader( "", "http://sol.kolmafia.us/" + filename ); String line; StringBuffer contents = new StringBuffer(); while ( ( line = reader.readLine() ) != null ) { contents.append( line ); contents.append( KoLConstants.LINE_BREAK ); } StringUtilities.globalStringReplace( contents, "images/", "http://sol.kolmafia.us/images/" ); PrintStream writer = RequestLogger.openStream( "relay/simulator/" + filename, NullStream.INSTANCE, true ); writer.println( contents.toString() ); writer.close(); } catch ( Exception e ) { KoLmafia.updateDisplay( KoLConstants.ERROR_STATE, "Failed to create simulator file <" + filename + ">" ); } } }

The table below shows all metrics for RelayRequest.java.

MetricValueDescription
BLOCKS176.00Number of blocks
BLOCK_COMMENT 0.00Number of block comment lines
COMMENTS106.00Comment lines
COMMENT_DENSITY 0.15Comment density
COMPARISONS180.00Number of comparison operators
CYCLOMATIC201.00Cyclomatic complexity
DECL_COMMENTS 1.00Comments in declarations
DOC_COMMENT32.00Number of javadoc comment lines
ELOC718.00Effective lines of code
EXEC_COMMENTS36.00Comments in executable code
EXITS162.00Procedure exits
FUNCTIONS29.00Number of function declarations
HALSTEAD_DIFFICULTY87.32Halstead difficulty
HALSTEAD_EFFORT 0.00Halstead effort
INTERFACE_COMPLEXITY96.00Interface complexity
JAVA0001 0.00JAVA0001 Package name does not contain only lower case letters
JAVA0002 0.00JAVA0002 Package name does not begin with a top level domain name or country code
JAVA0003 0.00JAVA0003 Minimize use of on-demand (.*) imports
JAVA0004 0.00JAVA0004 Unnecessary import from java.lang
JAVA0005 0.00JAVA0005 Imports not in specified order
JAVA0006 0.00JAVA0006 Empty finally block
JAVA0007 4.00JAVA0007 Should not declare public field
JAVA0008 4.00JAVA0008 Empty catch block
JAVA0009 0.00JAVA0009 Protected member in final class
JAVA0010 0.00JAVA0010 Non-instantiable class does not contain a non-private static member
JAVA0011 0.00JAVA0011 Abstract class does not contain an abstract method
JAVA0012 0.00JAVA0012 Non-constructor method with same name as declaring class
JAVA0013 0.00JAVA0013 Non-blank final field is not static
JAVA0014 0.00JAVA0014 Class with only static members has non-private constructor
JAVA0015 0.00JAVA0015 Package class contains public nested type
JAVA0016 0.00JAVA0016 Abstract class contains public constructor
JAVA0017 0.00JAVA0017 Class name does not have required form
JAVA0018 0.00JAVA0018 Method name does not have required form
JAVA0019 0.00JAVA0019 Interface name does not have required form
JAVA0020 0.00JAVA0020 Field name does not have required form
JAVA0021 0.00JAVA0021 Interface method name does not have required form
JAVA0022 0.00JAVA0022 Static final field name does not have required form
JAVA0023 0.00JAVA0023 Empty finalize method
JAVA0024 0.00JAVA0024 Empty class
JAVA0025 0.00JAVA0025 Method override is empty
JAVA0026 0.00JAVA0026 Finalize method with parameters
JAVA0029 0.00JAVA0029 Private method not used
JAVA0030 0.00JAVA0030 Private field not used
JAVA0031 0.00JAVA0031 Case statement not properly closed
JAVA0032 1.00JAVA0032 Switch statement missing default
JAVA0033 0.00JAVA0033 default: not last case in switch statement
JAVA0034 1.00JAVA0034 Missing braces in if statement
JAVA0035 0.00JAVA0035 Missing braces in for statement
JAVA0036 0.00JAVA0036 Missing braces in while statement
JAVA0038 0.00JAVA0038 Non-case label in switch statement
JAVA0039 0.00JAVA0039 Break statement with label
JAVA0040 0.00JAVA0040 Switch statement contains N cases (maximum: M)
JAVA0041 0.00JAVA0041 Nested synchronized block
JAVA0042 0.00JAVA0042 Empty synchronized statement
JAVA0043 0.00JAVA0043 Inner class does not use outer class
JAVA0044 0.00JAVA0044 Serializable class with no instance variables
JAVA0045 0.00JAVA0045 Serializable class with only transient fields
JAVA0046 0.00JAVA0046 Name of class not derived from Exception ends with 'Exception'
JAVA0047 0.00JAVA0047 Serializable class derives from invalid base class
JAVA0048 0.00JAVA0048 Name of class derived from Exception does not end with 'Exception'
JAVA0049 2.00JAVA0049 Nested block at depth N (maximum: M)
JAVA0050 0.00JAVA0050 Class derives from java.lang.Error
JAVA0051 0.00JAVA0051 Class derives from java.lang.RuntimeException
JAVA0052 0.00JAVA0052 Class derives from java.lang.Throwable
JAVA0053 0.00JAVA0053 Unused label
JAVA0054 1.00JAVA0054 Inheritance depth N exceeds maximum M
JAVA0055 0.00JAVA0055 Class should be interface
JAVA0056 0.00JAVA0056 Unnecessary abstract modifier for interface or annotation
JAVA0057 0.00JAVA0057 Unnecessary default constructor
JAVA0058 0.00JAVA0058 Constructor calls super()
JAVA0059 0.00JAVA0059 Method override only calls super()
JAVA0061 0.00JAVA0061 Inaccessible member in anonymous class
JAVA0062 0.00JAVA0062 Public class missing public member or protected constructor
JAVA0063 0.00JAVA0063 Identifier name should not contain '$'
JAVA0064 0.00JAVA0064 N variations of identifier name (maximum: M)
JAVA0065 0.00JAVA0065 Unnecessary final modifier for method in final class
JAVA0066 0.00JAVA0066 Unnecessary modifier for interface nested type
JAVA0067 0.00JAVA0067 Array descriptor on identifier name
JAVA0068 0.00JAVA0068 Modifiers not declared in recommended order
JAVA0071 0.00JAVA0071 Strings compared with ==
JAVA0073 0.00JAVA0073 Integer division in floating-point context
JAVA0074 0.00JAVA0074 Use of Object.notify()
JAVA0075 1.00JAVA0075 Method parameter hides field
JAVA007615.00JAVA0076 Use of magic number
JAVA0077 0.00JAVA0077 Private field not used in declaring class
JAVA0078 0.00JAVA0078 Floating point values compared with ==
JAVA0079 0.00JAVA0079 Use of instance to reference static member
JAVA0080 1.00JAVA0080 Import declaration not used
JAVA0081 0.00JAVA0081 Boolean literal in comparison
JAVA0082 0.00JAVA0082 Unnecessary widening cast
JAVA0083 0.00JAVA0083 Unnecessary instanceof test
JAVA0084 0.00JAVA0084 Should use compound assignment operator
JAVA0085 0.00JAVA0085 Use of sun.* class
JAVA0087 0.00JAVA0087 Use of Thread.sleep()
JAVA0089 0.00JAVA0089 Use of restricted package
JAVA0092 0.00JAVA0092 Use of restricted type
JAVA0093 0.00JAVA0093 Redundant assignment
JAVA0094 0.00JAVA0094 Field hides a superclass field
JAVA0095 0.00JAVA0095 Uninitialized private field
JAVA0096 0.00JAVA0096 Field in nested class hides outer field
JAVA0098 0.00JAVA0098 Minimize use of implicit field initializers
JAVA0100 0.00JAVA0100 Class contains N non-final fields (maximum: M)
JAVA0101 0.00JAVA0101 Unnecessary modifier for field in interface
JAVA0102 0.00JAVA0102 Last statement in finalize() not super.finalize()
JAVA0103 0.00JAVA0103 Explicit call to finalize()
JAVA0104 0.00JAVA0104 finalize() only calls super.finalize()
JAVA0105 0.00JAVA0105 Duplicate import declaration
JAVA0106 0.00JAVA0106 Unnecessary import from current package
JAVA0108 0.00JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0109 0.00JAVA0109 Incorrect javadoc: no parameter 'parameter'
JAVA0110 0.00JAVA0110 Incorrect javadoc: no @return tag
JAVA0111 0.00JAVA0111 Incorrect javadoc: @return tag for void method
JAVA0112 0.00JAVA0112 Incorrect javadoc: no exception 'exception' in throws
JAVA0113 0.00JAVA0113 Incorrect javadoc: no @author tag
JAVA0114 0.00JAVA0114 Incorrect javadoc: no @version tag
JAVA0115 0.00JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
JAVA0116 4.00JAVA0116 Missing javadoc: field 'field'
JAVA011710.00JAVA0117 Missing javadoc: method 'method'
JAVA0118 1.00JAVA0118 Missing javadoc: type 'type'
JAVA0119 1.00JAVA0119 Control variable changed within body of for loop
JAVA0123 0.00JAVA0123 Use all three components of for loop
JAVA0125 0.00JAVA0125 Continue statement with label
JAVA0126 0.00JAVA0126 Method declares unchecked exception in throws
JAVA0128 0.00JAVA0128 Public constructor in non-public class
JAVA0130 2.00JAVA0130 Non-static method does not use instance fields
JAVA0131 0.00JAVA0131 Compatible method does not override base
JAVA0132 0.00JAVA0132 Method overload with compatible signature
JAVA0133 0.00JAVA0133 Non-synchronized method overrides synchronized method
JAVA0135 0.00JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method'
JAVA0136 1.00JAVA0136 N methods defined in class (maximum: M)
JAVA0137 0.00JAVA0137 Non-abstract class missing constructor
JAVA0138 1.00JAVA0138 N parameters defined for method (maximum: M)
JAVA0139 0.00JAVA0139 Definition of main other than public static void main(java.lang.String[])
JAVA0141 0.00JAVA0141 Unnecessary modifier for method in interface
JAVA0143 0.00JAVA0143 Synchronized method
JAVA014421.00JAVA0144 Line exceeds maximum M characters
JAVA01452748.00JAVA0145 Tab character used in source file
JAVA0150 0.00JAVA0150 java.lang.Error (or subclass) thrown
JAVA0153 0.00JAVA0153 Inefficient conversion of integer to string
JAVA0159 0.00JAVA0159 Inefficient conversion of string to integer
JAVA0160 0.00JAVA0160 Method does not throw specified exception
JAVA0161 0.00JAVA0161 Conditional wait() not in loop
JAVA0163 0.00JAVA0163 Empty statement
JAVA0165 0.00JAVA0165 Conflicting return statement in finally block
JAVA0166 2.00JAVA0166 Generic exception caught
JAVA0167 0.00JAVA0167 ThreadDeath not rethrown
JAVA0169 0.00JAVA0169 Unnecessary catch block: exception 'exception'
JAVA0170 0.00JAVA0170 Caught exception not derived from java.lang.Exception
JAVA0171 0.00JAVA0171 Unused local variable
JAVA0173 0.00JAVA0173 Unused method parameter
JAVA0174 0.00JAVA0174 Assigned local variable never used
JAVA0175 0.00JAVA0175 Successive assignment to variable
JAVA0176 0.00JAVA0176 Local variable name does not have required form
JAVA0177 5.00JAVA0177 Variable declaration missing initializer
JAVA0179 0.00JAVA0179 Local variable hides visible field
JAVA0233 0.00JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID'
JAVA0234 0.00JAVA0234 Class is Serializable but does not define serialVersionUID
JAVA0235 0.00JAVA0235 Class defines serialVersionUID but does not implement Serializable
JAVA0236 0.00JAVA0236 Attempt to clone an object which does not implement Cloneable
JAVA0237 0.00JAVA0237 Class implements Cloneable but does not have public clone method
JAVA0238 0.00JAVA0238 Clone method does not call super.clone()
JAVA0239 0.00JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable
JAVA0240 0.00JAVA0240 Serializable class which declares readObject or writeObject but not both
JAVA0241 0.00JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class
JAVA0242 0.00JAVA0242 Transient field in non-Serializable class
JAVA0243 0.00JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected
JAVA0244 0.00JAVA0244 Field or method name in subclass differs only by case from inherited field or method
JAVA0245 0.00JAVA0245 JUnit TestCase with non-trivial constructor
JAVA0246 0.00JAVA0246 JUnit assertXXX statement missing message parameter
JAVA0247 0.00JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method
JAVA0248 0.00JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature
JAVA0249 0.00JAVA0249 JUnit TestCase 'suite()' should be declared static
JAVA0250 0.00JAVA0250 JUnit TestCase declares testXXX method with incorrect signature
JAVA0251 0.00JAVA0251 Use '%n' for line breaks in printf/format for platform independence
JAVA0252 0.00JAVA0252 'enum' is a Java 1.5 reserved word
JAVA0253 0.00JAVA0253 Not all enum constants consumed in switch statement
JAVA0254 0.00JAVA0254 Use enhanced for loop construct instead of Iterator
JAVA0255 0.00JAVA0255 Result of method invocation not used
JAVA0256 0.00JAVA0256 Assignment of external collection/array to field
JAVA0257 0.00JAVA0257 Use of 'Constant Interface' anti-pattern
JAVA0258 0.00JAVA0258 Implement Iterable for foreach compatibility
JAVA0259 0.00JAVA0259 Return of collection/array field
JAVA0260 0.00JAVA0260 Use 'enum' instead of Enumerated Type pattern
JAVA0261 0.00JAVA0261 Use specialized Enum collection types
JAVA0262 0.00JAVA0262 Use of char in integer context
JAVA0263 0.00JAVA0263 Long literal ends with 'l' instead of 'L'
JAVA0264 1.00JAVA0264 Integer math in long context - check for overflow
JAVA0265 0.00JAVA0265 Use of Throwable.printStackTrace()
JAVA0266 0.00JAVA0266 Use of System.out
JAVA0267 0.00JAVA0267 Use of System.err
JAVA0269 0.00JAVA0269 Contents of StringBuffer never used
JAVA0270 0.00JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
JAVA0271 0.00JAVA0271 Minimize use of on-demand (.*) static imports
JAVA0272 0.00JAVA0272 Thread.run() called
JAVA0273 0.00JAVA0273 Non-final derivative of Thread calls start() in constructor
JAVA0274 0.00JAVA0274 Serializable class has a synchronized readObject()
JAVA0275 0.00JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods
JAVA0276 0.00JAVA0276 Unnecessary use of String constructor
JAVA0277 0.00JAVA0277 Iterator.next() implementation does not throw NoSuchElementException
JAVA0278 0.00JAVA0278 Unnecessary use of Boolean constructor
JAVA0279 0.00JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method
JAVA0280 0.00JAVA0280 IllegalMonitorStateException caught
JAVA0281 0.00JAVA0281 Iterator.next() not called in loop
JAVA0282 0.00JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext()
JAVA0283 0.00JAVA0283 Control variable not updated in loop body
JAVA0284 0.00JAVA0284 Explicit garbage collection
JAVA0285 0.00JAVA0285 Dereference of potentially null variable
JAVA0286 0.00JAVA0286 Dereference of null variable
JAVA0287 0.00JAVA0287 Unnecessary null check
JAVA0288 0.00JAVA0288 Inconsistent null check
LINES1435.00Number of lines in the source file
LINE_COMMENT74.00Number of line comments
LOC1074.00Lines of code
LOGICAL_LINES521.00Number of statements
LOOPS14.00Number of loops
NEST_DEPTH 6.00Maximum nesting depth
OPERANDS2267.00Number of operands
OPERATORS4442.00Number of operators
PARAMS27.00Number of formal parameter declarations
PROGRAM_LENGTH6709.00Halstead program length
PROGRAM_VOCAB755.00Halstead program vocabulary
PROGRAM_VOLUME 0.00Halstead program volume
RETURNS69.00Number of return points from functions
SIZE46249.00Size of the file in bytes
UNIQUE_OPERANDS701.00Number of unique operands
UNIQUE_OPERATORS54.00Number of unique operators
WHITESPACE255.00Number of whitespace lines