/**
* Copyright (C) 2002-2012 The FreeCol Team
*
* This file is part of FreeCol.
*
* FreeCol 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.
*
* FreeCol 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 FreeCol. If not, see <http://www.gnu.org/licenses/>.
*/
package net.sf.freecol.server.ai.mission;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Logger;
import org.freecolandroid.xml.stream.XMLStreamException;
import org.freecolandroid.xml.stream.XMLStreamReader;
import org.freecolandroid.xml.stream.XMLStreamWriter;
import net.sf.freecol.common.model.Colony;
import net.sf.freecol.common.model.Goods;
import net.sf.freecol.common.model.GoodsContainer;
import net.sf.freecol.common.model.GoodsType;
import net.sf.freecol.common.model.IndianSettlement;
import net.sf.freecol.common.model.Map.Direction;
import net.sf.freecol.common.model.Player;
import net.sf.freecol.common.model.Tension;
import net.sf.freecol.common.networking.Connection;
import net.sf.freecol.common.util.Utils;
import net.sf.freecol.server.ai.AIMain;
import net.sf.freecol.server.ai.AIMessage;
import net.sf.freecol.server.ai.AIUnit;
import org.w3c.dom.Element;
/**
* Mission for bringing a gift to a specified player.
*
* <BR>
* <BR>
*
* The mission has three different tasks to perform:
* <ol>
* <li>Get the gift (goods) from the {@link IndianSettlement} that owns the
* unit.
* <li>Transport this gift to the given {@link Colony}.
* <li>Complete the mission by delivering the gift.
* </ol>
*/
public class IndianBringGiftMission extends Mission {
private static final Logger logger = Logger.getLogger(IndianBringGiftMission.class.getName());
/** The <code>Colony</code> receiving the gift. */
private Colony target;
/** Decides whether this mission has been completed or not. */
private boolean completed;
/**
* Creates a mission for the given <code>AIUnit</code>.
*
* @param aiMain The main AI-object.
* @param aiUnit The <code>AIUnit</code> this mission is created for.
* @param target The <code>Colony</code> receiving the gift.
*/
public IndianBringGiftMission(AIMain aiMain, AIUnit aiUnit, Colony target) {
super(aiMain, aiUnit);
this.target = target;
this.completed = false;
if (!getUnit().getOwner().isIndian() || !getUnit().canCarryGoods()) {
logger.warning("Only an indian which can carry goods can be given the mission: IndianBringGiftMission");
throw new IllegalArgumentException("Only an indian which can carry goods can be given the mission: IndianBringGiftMission");
}
}
/**
* Loads a mission from the given element.
*
* @param aiMain The main AI-object.
* @param element An <code>Element</code> containing an XML-representation
* of this object.
*/
public IndianBringGiftMission(AIMain aiMain, Element element) {
super(aiMain);
readFromXMLElement(element);
}
/**
* Creates a new <code>IndianBringGiftMission</code> and reads the given
* element.
*
* @param aiMain The main AI-object.
* @param in The input stream containing the XML.
* @throws XMLStreamException if a problem was encountered during parsing.
* @see net.sf.freecol.server.ai.AIObject#readFromXML
*/
public IndianBringGiftMission(AIMain aiMain, XMLStreamReader in) throws XMLStreamException {
super(aiMain);
readFromXML(in);
}
/**
* Performs the mission.
*
* @param connection The <code>Connection</code> to the server.
*/
public void doMission(Connection connection) {
if (!isValid()) {
// the destination colony may have been destroyed
return;
}
if (!hasGift()) {
if (getUnit().getTile() != getUnit().getIndianSettlement().getTile()) {
// Move to the owning settlement:
Direction r = moveTowards(getUnit().getIndianSettlement().getTile());
if (r == null || !moveButDontAttack(r)) return;
} else {
IndianSettlement is = getUnit().getIndianSettlement();
// Load the goods:
List<Goods> goodsList = new ArrayList<Goods>();
GoodsContainer gc = is.getGoodsContainer();
for (GoodsType goodsType : getSpecification().getNewWorldGoodsTypeList()) {
if (gc.getGoodsCount(goodsType) >= IndianSettlement.KEEP_RAW_MATERIAL + 25) {
Goods goods = new Goods(getGame(), is, goodsType,
Utils.randomInt(logger, "Gift amount",
getAIRandom(), 15) + 10);
goodsList.add(goods);
}
}
if (goodsList.size() == 0) {
completed = true;
} else {
Goods goods = goodsList.get(Utils.randomInt(logger,
"Gift amount", getAIRandom(), goodsList.size()));
AIMessage.askLoadCargo(getAIUnit(), goods);
}
}
} else {
// Move to the target's colony and deliver
Direction r = moveTowards(target.getTile());
if (r != null
&& getUnit().getTile().getNeighbourOrNull(r) == target.getTile()) {
// We have arrived.
if (AIMessage.askGetTransaction(getAIUnit(), target)
&& AIMessage.askDeliverGift(getAIUnit(), target,
getUnit().getGoodsIterator().next())) {
AIMessage.askCloseTransaction(getAIUnit(), target);
logger.info("IndianBringGift for " + getUnit().getId()
+ " delivered at " + target.getName());
} else {
logger.warning("IndianBringGift for " + getUnit().getId()
+ " failed at " + target.getName());
}
completed = true;
}
}
// Walk in a random direction if we have any moves left:
moveRandomly();
}
/**
* Checks if the unit is carrying a gift (goods).
*
* @return <i>true</i> if <code>getUnit().getSpaceLeft() == 0</code> and
* false otherwise.
*/
private boolean hasGift() {
return (getUnit().getSpaceLeft() == 0);
}
/**
* Checks if this mission is still valid to perform.
*
* This mission will be invalidated when the gift has been
* delivered. In case of the stances {@link
* net.sf.freecol.common.model.Player.Stance#WAR WAR} or {@link
* net.sf.freecol.common.model.Player.Stance#CEASE_FIRE
* CEASE_FIRE} towards the target player, the mission would be
* invalidated as well.
*
* @return True if this mission is still valid.
*/
public boolean isValid() {
return super.isValid() && !completed
&& target != null && !target.isDisposed()
&& target.getTile().getColony() == target
&& isValidMission(getUnit().getOwner(), target.getOwner())
&& getUnit().getIndianSettlement() != null;
}
/**
* Checks if the player <code>owner</code> can bring a gift to the
* <code>targetPlayer</code>.
*
* @param owner The owner of this mission.
* @param targetPlayer The target of the gift.
* @return <code>true</code> if this mission is still valid to perform
* with regard to the tension towards the target player.
*/
public static boolean isValidMission(Player owner, Player targetPlayer) {
switch (owner.getStance(targetPlayer)) {
case UNCONTACTED: case WAR: case CEASE_FIRE:
break;
case PEACE: case ALLIANCE:
return owner.getTension(targetPlayer).getLevel().compareTo(Tension.Level.HAPPY) <= 0;
}
return false;
}
/**
* Gets debugging information about this mission. This string is a short
* representation of this object's state.
*
* @return The <code>String</code>: "[ColonyName] GIFT_TYPE" or
* "[ColonyName] Getting gift: (x, y)".
*/
public String getDebuggingInfo() {
if (!hasGift()) {
return "[" + target.getName() + "] Getting gift: "
+ getUnit().getIndianSettlement().getTile().getPosition();
} else {
return "[" + target.getName() + "] "
+ getUnit().getGoodsIterator().next().getNameKey();
}
}
/**
* Writes all of the <code>AIObject</code>s and other AI-related
* information to an XML-stream.
*
* @param out The target stream.
* @throws XMLStreamException if there are any problems writing to the
* stream.
*/
protected void toXMLImpl(XMLStreamWriter out) throws XMLStreamException {
toXML(out, getXMLElementTagName());
}
protected void writeAttributes(XMLStreamWriter out) throws XMLStreamException {
super.writeAttributes(out);
if (target != null) {
out.writeAttribute("target", target.getId());
}
out.writeAttribute("completed", Boolean.toString(completed));
}
/**
* Reads all the <code>AIObject</code>s and other AI-related information
* from XML data.
*
* @param in The input stream with the XML.
* @throws XMLStreamException if there are any problems reading
* from the stream.
*/
protected void readAttributes(XMLStreamReader in) throws XMLStreamException {
super.readAttributes(in);
String targetString = in.getAttributeValue(null, "target");
target = (targetString == null) ? null
: (Colony) getGame().getFreeColGameObject(targetString);
String completedString = in.getAttributeValue(null, "completed");
if (completedString == null) { // @compat 0.9.x
completedString = in.getAttributeValue(null, "giftDelivered");
} // end compatibility code
completed = Boolean.valueOf(completedString).booleanValue();
}
/**
* Returns the tag name of the root element representing this object.
*
* @return "indianBringGiftMission".
*/
public static String getXMLElementTagName() {
return "indianBringGiftMission";
}
}