Aliases.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.persistence;

import java.io.BufferedReader;
import java.io.File;
import java.io.PrintStream;

import java.util.Iterator;
import java.util.Map.Entry;
import java.util.Set;
import java.util.TreeMap;

import net.sourceforge.kolmafia.KoLConstants;
import net.sourceforge.kolmafia.RequestLogger;
import net.sourceforge.kolmafia.StaticEntity;

import net.sourceforge.kolmafia.utilities.CharacterEntities;
import net.sourceforge.kolmafia.utilities.FileUtilities;
import net.sourceforge.kolmafia.utilities.LogStream;
import net.sourceforge.kolmafia.utilities.StringUtilities;

public class Aliases
{
	private static final File ALIAS_FILE = new File( KoLConstants.SETTINGS_LOCATION, "GLOBAL_aliases.txt" );
	private static final TreeMap aliasMap = new TreeMap();

	private static boolean loadedAliases = false;
	private static Set aliasSet = null;

	private static void load()
	{
		if ( loadedAliases )
		{
			return;
		}

		File oldAliasFile = new File( KoLConstants.SETTINGS_LOCATION, "aliases_GLOBAL.txt" );
		if ( oldAliasFile.exists() )
		{
			oldAliasFile.renameTo( Aliases.ALIAS_FILE );
		}

		Aliases.aliasMap.clear();

		BufferedReader reader = FileUtilities.getReader( Aliases.ALIAS_FILE );
		if ( reader != null )
		{
			String[] data;

			while ( ( data = FileUtilities.readData( reader ) ) != null )
			{
				if ( data.length >= 2 )
				{
					Aliases.aliasMap.put( " " + data[ 0 ] + " ", " " + data[ 1 ] + " " );
				}
			}

			try
			{
				reader.close();
			}
			catch ( Exception e )
			{
				StaticEntity.printStackTrace( e );
			}
		}

		Aliases.aliasSet = Aliases.aliasMap.entrySet();
		loadedAliases = true;
	}

	public static void save()
	{
		PrintStream aliasStream = LogStream.openStream( Aliases.ALIAS_FILE, true );

		Iterator it = Aliases.aliasSet.iterator();
		while ( it.hasNext() )
		{
			Entry current = (Entry) it.next();
			String aliasString = (String) current.getKey();
			String aliasCommand = (String) current.getValue();
			aliasStream.println( aliasString.trim() + "\t" + aliasCommand.trim() );
		}

		aliasStream.close();
	}

	public static String apply( String line )
	{
		Aliases.load();

		if ( Aliases.aliasSet.size() == 0 )
		{
			return line;
		}

		if ( line.startsWith( "alias " ) || line.startsWith( "unalias " ) )
		{
			return line;
		}

		line = " " + line + " ";

		Iterator it = Aliases.aliasSet.iterator();
		while ( it.hasNext() )
		{
			Entry current = (Entry) it.next();
			String aliasString = (String) current.getKey();
			String aliasCommand = (String) current.getValue();

			// If the alias has a "%%" that means the person is using the old
			// aliasing scheme where only the first word can be considered a
			// part of the alias.

			if ( aliasCommand.indexOf( "%%" ) != -1 )
			{
				if ( line.startsWith( aliasString ) )
				{
					String parameters = line.substring( aliasString.length() );
					line = StringUtilities.globalStringReplace( aliasCommand, "%%", parameters );
				}
			}

			// Otherwise, it's likely that this is a newer style alias where
			// we just expand a word or phrase.

			else
			{
				line = StringUtilities.singleStringReplace( line, aliasString, aliasCommand );
			}
		}

		return line.trim();
	}

	public static void add( final String aliasString, final String aliasCommand )
	{
		Aliases.aliasMap.put( " " + aliasString + " ", " " + aliasCommand + " " );
		Aliases.aliasSet = Aliases.aliasMap.entrySet();
		save();
	}

	public static void remove( final String aliasString )
	{
		Aliases.aliasMap.remove(  " " + aliasString + " " );
		Aliases.aliasSet = Aliases.aliasMap.entrySet();
		save();
	}

	public static void print( final String filter )
	{
		StringBuffer buffer = new StringBuffer();
		Iterator it = Aliases.aliasSet.iterator();
		boolean first = true;
		while ( it.hasNext() )
		{
			Entry current = (Entry) it.next();
			String aliasString = (String) current.getKey();
			String aliasCommand = (String) current.getValue();

			boolean matches = filter.equals( "" );

			if ( !matches )
			{
				matches = ( aliasString.toLowerCase().indexOf( filter ) != -1 ||
				            aliasCommand.toLowerCase().indexOf( filter ) != -1   );
			}

			if ( !matches )
			{
				continue;
			}

			if ( first )
			{
				first = false;
			}
			else
			{
				buffer.append( KoLConstants.LINE_BREAK );
				buffer.append( KoLConstants.LINE_BREAK );
			}
			buffer.append( "<b>" );
			buffer.append( aliasString );
			buffer.append( "</b> => " );
			buffer.append( CharacterEntities.escape( aliasCommand ) );
		}

		RequestLogger.printLine( buffer.toString() );
	}
}