RichardRequest.java

/**
 * Copyright (c) 2005-2017, 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.util.regex.Matcher;
import java.util.regex.Pattern;

import net.sourceforge.kolmafia.KoLAdventure;
import net.sourceforge.kolmafia.KoLCharacter;
import net.sourceforge.kolmafia.KoLConstants.MafiaState;
import net.sourceforge.kolmafia.KoLmafia;
import net.sourceforge.kolmafia.RequestLogger;

public class RichardRequest
	extends GenericRequest
{
	public static final int MYSTICALITY = 1;
	public static final int MOXIE = 2;
	public static final int MUSCLE = 3;

	private static final Pattern TURN_PATTERN = Pattern.compile( "numturns=(\\d+)" );

	private int turnCount = 1;

	/**
	 * Constructs a new <code>RichardRequest</code>.
	 *
	 * @param equipmentId The identifier for the equipment you're using
	 */

	public RichardRequest( final int equipmentId )
	{
		super( "clan_hobopolis.php" );
		this.addFormField( "place", "3" );
		this.addFormField( "preaction", "spendturns" );
		this.addFormField( "whichservice", String.valueOf( equipmentId ) );
	}

	public RichardRequest setTurnCount( final int turnCount )
	{
		this.turnCount = turnCount;
		return this;
	}

	@Override
	public void run()
	{
		this.addFormField( "numturns", String.valueOf( this.turnCount ) );

		if ( KoLCharacter.getAdventuresLeft() < this.turnCount )
		{
			KoLmafia.updateDisplay( MafiaState.ERROR, "Insufficient adventures." );
			return;
		}

		KoLmafia.updateDisplay( "Helping Richard..." );

		super.run();
	}

	@Override
	public void processResults()
	{
		KoLmafia.updateDisplay( "Workout completed." );
	}

	/**
	 * An alternative method to doing adventure calculation is determining how many adventures are used by the given
	 * request, and subtract them after the request is done. This number defaults to <code>zero</code>; overriding
	 * classes should change this value to the appropriate amount.
	 *
	 * @return The number of adventures used by this request.
	 */

	@Override
	public int getAdventuresUsed()
	{
		return this.turnCount;
	}

	public static boolean registerRequest( final String urlString )
	{
		String gymType = null;

		if ( !urlString.startsWith( "clan_hobopolis.php" ) ||
			urlString.indexOf( "place=3" ) == -1 ||
			urlString.indexOf( "preaction=spendturns" ) == -1 )
		{
			return false;
		}

		if ( urlString.indexOf( "whichservice=1" ) != -1 )
		{
			gymType = "Help Richard make bandages (Mysticality)";
		}
		if ( urlString.indexOf( "whichservice=2" ) != -1 )
		{
			gymType = "Help Richard make grenades (Moxie)";
		}
		if ( urlString.indexOf( "whichservice=3" ) != -1 )
		{
			gymType = "Help Richard make shakes (Muscle)";
		}

		if ( gymType == null )
		{
			return false;
		}

		Matcher turnMatcher = RichardRequest.TURN_PATTERN.matcher( urlString );
		if ( !turnMatcher.find() )
		{
			return false;
		}

		RequestLogger.printLine( "[" + KoLAdventure.getAdventureCount() + "] " + gymType + " (" + turnMatcher.group( 1 ) + " turns)" );
		RequestLogger.updateSessionLog( "[" + KoLAdventure.getAdventureCount() + "] " + gymType + " (" + turnMatcher.group( 1 ) + " turns)" );
		return true;
	}
}