foul-magics/Mage/src/main/java/mage/abilities/keyword/HauntAbility.java

package mage.abilities.keyword;

import mage.MageObject;
import mage.abilities.Ability;
import mage.abilities.TriggeredAbilityImpl;
import mage.abilities.common.ZoneChangeTriggeredAbility;
import mage.abilities.effects.Effect;
import mage.abilities.effects.OneShotEffect;
import mage.cards.Card;
import mage.constants.Outcome;
import mage.constants.Zone;
import mage.game.Game;
import mage.game.events.GameEvent;
import mage.game.events.ZoneChangeEvent;
import mage.game.permanent.Permanent;
import mage.target.common.TargetCreaturePermanent;
import mage.target.targetpointer.FixedTarget;

/**
 * 702.53. Haunt
 *
 * 702.53a Haunt is a triggered ability. "Haunt" on a permanent means "When this
 * permanent is put into a graveyard from the battlefield, exile it haunting
 * target creature." "Haunt" on an instant or sorcery spell means "When this
 * spell is put into a graveyard during its resolution, exile it haunting target
 * creature."
 *
 * 702.53b Cards that are in the exile zone as the result of a haunt ability
 * "haunt" the creature targeted by that ability. The phrase "creature it
 * haunts" refers to the object targeted by the haunt ability, regardless of
 * whether or not that object is still a creature.
 *
 * 702.53c Triggered abilities of cards with haunt that refer to the haunted
 * creature can trigger in the exile zone.
 *
 * @author LevelX2
 */
public class HauntAbility extends TriggeredAbilityImpl {

    private boolean usedFromExile = false;
    private boolean creatureHaunt;

    public HauntAbility(Card card, Effect effect) {
        super(Zone.ALL, effect, false);
        creatureHaunt = card.isCreature();
        addSubAbility(new HauntExileAbility(creatureHaunt));
    }

    public HauntAbility(final HauntAbility ability) {
        super(ability);
        this.usedFromExile = ability.usedFromExile;
        this.creatureHaunt = ability.creatureHaunt;
    }

    @Override
    public HauntAbility copy() {
        return new HauntAbility(this);
    }

    @Override
    public boolean checkEventType(GameEvent event, Game game) {
        switch (event.getType()) {
            case ENTERS_THE_BATTLEFIELD:
            case ZONE_CHANGE:
                return true;
        }
        return false;
    }

    @Override
    public boolean checkTrigger(GameEvent event, Game game) {
        switch (event.getType()) {
            case ENTERS_THE_BATTLEFIELD:
                if (game.getState().getZone(getSourceId()) == Zone.BATTLEFIELD) {
                    return event.getTargetId().equals(getSourceId());
                }
                break;
            case ZONE_CHANGE:
                if (!usedFromExile
                        && game.getState().getZone(getSourceId()) == Zone.EXILED) {
                    ZoneChangeEvent zEvent = (ZoneChangeEvent) event;
                    if (zEvent.isDiesEvent()) {
                        Card card = game.getCard(getSourceId());
                        if (card != null
                                && game.getCard(event.getTargetId()) != null) {
                            String key = new StringBuilder("Haunting_")
                                    .append(getSourceId().toString())
                                    .append(card.getZoneChangeCounter(game)
                                            + (game.getPermanentOrLKIBattlefield(event.getTargetId()))
                                                    .getZoneChangeCounter(game)).toString();
                            Object object = game.getState().getValue(key);
                            if (object instanceof FixedTarget) {
                                FixedTarget target = (FixedTarget) object;
                                if (target.getTarget() != null
                                        && target.getTarget()
                                                .equals(event.getTargetId())) {
                                    usedFromExile = true;
                                    return true;
                                }
                            }
                        }
                    }
                }
                break;
            default:
                return false;
        }
        return false;
    }

    @Override
    public String getRule() {
        return (creatureHaunt ? "When {this} enters the battlefield or the creature it haunts dies, "
                : "When the creature {this} haunts dies, ")
                + super.getRule();
    }
}

class HauntExileAbility extends ZoneChangeTriggeredAbility {

    private static final String RULE_TEXT_CREATURE = "Haunt <i>(When this creature dies, "
            + "exile it haunting target creature.)</i>";
    private static final String RULE_TEXT_SPELL = "Haunt <i>(When this spell card is put "
            + "into a graveyard after resolving, exile it haunting target creature.)</i>";

    private boolean creatureHaunt;

    // TODO: It's not checked yet, if the Haunt spell has resolved (and was not countered or removed from stack).
    public HauntExileAbility(boolean creatureHaunt) {
        super(creatureHaunt ? Zone.BATTLEFIELD : Zone.STACK, Zone.GRAVEYARD, new HauntEffect(), null, false);
        this.creatureHaunt = creatureHaunt;
        this.setRuleAtTheTop(creatureHaunt);
        this.addTarget(new TargetCreaturePermanent());

    }

    public HauntExileAbility(final HauntExileAbility ability) {
        super(ability);
        this.creatureHaunt = ability.creatureHaunt;
    }

    @Override
    public boolean isInUseableZone(Game game, MageObject source, GameEvent event) {
        boolean fromOK = true;
        Permanent sourcePermanent = (Permanent) game.getLastKnownInformation(sourceId, Zone.BATTLEFIELD);
        if (creatureHaunt
                && sourcePermanent == null) {
            // check it was previously on battlefield
            fromOK = false;
        }
        if (!this.hasSourceObjectAbility(game, sourcePermanent, event)) {
            return false;
        }
        // check now it is in graveyard
        Zone after = game.getState().getZone(sourceId);
        return fromOK
                && after != null
                && Zone.GRAVEYARD.match(after);
    }

    @Override
    public String getRule() {
        return creatureHaunt ? RULE_TEXT_CREATURE : RULE_TEXT_SPELL;
    }

    @Override
    public HauntExileAbility copy() {
        return new HauntExileAbility(this);
    }
}

class HauntEffect extends OneShotEffect {

    public HauntEffect() {
        super(Outcome.Benefit);
        this.staticText = "exile it haunting target creature";
    }

    public HauntEffect(final HauntEffect effect) {
        super(effect);
    }

    @Override
    public HauntEffect copy() {
        return new HauntEffect(this);
    }

    @Override
    public boolean apply(Game game, Ability source) {
        Card card = game.getCard(source.getSourceId());
        if (card != null) {
            Permanent hauntedCreature = game.getPermanent(targetPointer.getFirst(game, source));
            // haunting card will only be moved to exile, if 
            if (hauntedCreature != null) {
                if (card.moveToExile(source.getSourceId(), "Haunting", source.getSourceId(), game)) {
                    // remember the haunted creature
                    String key = new StringBuilder("Haunting_")
                            .append(source.getSourceId().toString())
                            .append(card.getZoneChangeCounter(game)
                                    + hauntedCreature.getZoneChangeCounter(game)).toString();  // in case it is blinked
                    game.getState().setValue(key, new FixedTarget(targetPointer.getFirst(game, source)));
                    card.addInfo("hauntinfo", new StringBuilder("Haunting ").append(hauntedCreature.getLogName()).toString(), game);
                    hauntedCreature.addInfo("hauntinfo", new StringBuilder("Haunted by ").append(card.getLogName()).toString(), game);
                    if (!game.isSimulation()) {
                        game.informPlayers(new StringBuilder(card.getName()).append(" haunting ").append(hauntedCreature.getLogName()).toString());
                    }
                }
                return true;
            }
        }
        return false;
    }
}