AbstractScriptProcess.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient 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.
 *
 * JXClient 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 JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Copyright (C) 2005-2008 Yann Chachkoff
 * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
 * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
 */
 
package com.realtime.crossfire.jxclient.scripts;
 
import com.realtime.crossfire.jxclient.faces.Face;
import com.realtime.crossfire.jxclient.items.CfItem;
import com.realtime.crossfire.jxclient.items.FloorView;
import com.realtime.crossfire.jxclient.items.ItemSet;
import com.realtime.crossfire.jxclient.map.CfMap;
import com.realtime.crossfire.jxclient.map.CfMapSquare;
import com.realtime.crossfire.jxclient.map.MapUpdaterState;
import com.realtime.crossfire.jxclient.queue.CommandQueue;
import com.realtime.crossfire.jxclient.server.crossfire.CrossfireDrawinfoListener;
import com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection;
import com.realtime.crossfire.jxclient.server.socket.ClientSocketListener;
import com.realtime.crossfire.jxclient.server.socket.ClientSocketMonitorCommand;
import com.realtime.crossfire.jxclient.skills.Skill;
import com.realtime.crossfire.jxclient.skills.SkillSet;
import com.realtime.crossfire.jxclient.spells.Spell;
import com.realtime.crossfire.jxclient.spells.SpellsManager;
import com.realtime.crossfire.jxclient.stats.Stats;
import com.realtime.crossfire.jxclient.util.EventListenerList2;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public abstract class AbstractScriptProcess implements Runnable, ScriptProcess {
 
    @NotNull
    private static final Pattern PATTERN_ISSUE = Pattern.compile("(-?[0-9]+) +(-?[0-9]+) +(.+)");
 
    private final int scriptId;
 
    @NotNull
    private final String filename;
 
    @NotNull
    private final CommandQueue commandQueue;
 
    @NotNull
    private final CrossfireServerConnection crossfireServerConnection;
 
    @NotNull
    private final Stats stats;
 
    @NotNull
    private final FloorView floorView;
 
    @NotNull
    private final ItemSet itemSet;
 
    @NotNull
    private final SpellsManager spellsManager;
 
    @NotNull
    private final MapUpdaterState mapUpdaterState;
 
    @NotNull
    private final SkillSet skillSet;
 
    @NotNull
    private final EventListenerList2<ScriptProcessListener> scriptProcessListeners = new EventListenerList2<>();
 
    @NotNull
    private final PacketWatcher packetWatcher;
 
    private boolean isMonitoring;
 
    private int posX;
 
    private int posY;
 
    @NotNull
    private final ClientSocketListener clientSocketListener = new ClientSocketListener() {
 
        @Override
        public void connecting() {
            // ignore
        }
 
        @Override
        public void connected() {
            // ignore
        }
 
        @Override
        public void packetReceived(@NotNull final ByteBuffer packet) {
            // ignore
        }
 
        @Override
        public void packetSent(@NotNull final ClientSocketMonitorCommand monitor) {
            commandSent(monitor.getMonitorCommand());
        }
 
        @Override
        public void disconnected(@NotNull final String reason) {
            // ignore
        }
 
    };
 
    protected AbstractScriptProcess(final int scriptId, @NotNull final String filename, @NotNull final CommandQueue commandQueue, @NotNull final CrossfireServerConnection crossfireServerConnection, @NotNull final Stats stats, @NotNull final FloorView floorView, @NotNull final ItemSet itemSet, @NotNull final SpellsManager spellsManager, @NotNull final MapUpdaterState mapUpdaterState, @NotNull final SkillSet skillSet) {
        this.scriptId = scriptId;
        this.filename = filename;
        this.commandQueue = commandQueue;
        this.crossfireServerConnection = crossfireServerConnection;
        this.stats = stats;
        this.floorView = floorView;
        this.itemSet = itemSet;
        this.spellsManager = spellsManager;
        this.mapUpdaterState = mapUpdaterState;
        this.skillSet = skillSet;
        packetWatcher = new PacketWatcher(crossfireServerConnection, this);
    }
 
    @Override
    public int getScriptId() {
        return scriptId;
    }
 
    @NotNull
    @Override
    public String getFilename() {
        return filename;
    }
 
    @Override
    public void run() {
        @Nullable String result = "unexpected";
        try {
            try {
                mapUpdaterState.addCrossfireMapScrollListener(this::mapScroll);
                try {
                    mapUpdaterState.addCrossfireNewmapListener(this::newmap);
                    try {
                        while (true) {
                            final String line = readFromScript();
                            if (line == null) {
                                break;
                            }
 
                            runScriptCommand(line);
                        }
                        result = waitForTermination();
                    } finally {
                        mapUpdaterState.removeCrossfireNewmapListener(this::newmap);
                    }
                } finally {
                    mapUpdaterState.removeCrossfireMapScrollListener(this::mapScroll);
                }
            } catch (final IOException ex) {
                result = ex.getMessage();
            }
        } finally {
            if (isMonitoring) {
                crossfireServerConnection.removeClientSocketListener(clientSocketListener);
            }
            packetWatcher.destroy();
            for (ScriptProcessListener scriptProcessListener : scriptProcessListeners) {
                scriptProcessListener.scriptTerminated(result);
            }
        }
    }
 
    private void mapScroll(final int dx, final int dy) {
        final CfMap map = mapUpdaterState.getMap();
        //noinspection SynchronizationOnLocalVariableOrMethodParameter
        synchronized (map) {
            posX += dx;
            posY += dy;
        }
    }
 
    private void newmap() {
        final CfMap map = mapUpdaterState.getMap();
        //noinspection SynchronizationOnLocalVariableOrMethodParameter
        synchronized (map) {
            posX = 0;
            posY = 0;
        }
    }
 
    @Nullable
    protected abstract String readFromScript() throws IOException;
 
    @Nullable
    protected abstract String waitForTermination();
 
    @Override
    public void commandSent(@NotNull final String cmd) {
        try {
            writeToScript(cmd+"\n");
        } catch (final IOException ex) {
            reportError(ex.getMessage());
            killScript();
        }
    }
 
    protected abstract void writeToScript(@NotNull final String data) throws IOException;
 
    private void commandSentItem(@NotNull final String cmd, @NotNull final CfItem item) {
        int flags = 0;
        if (item.isMagic()) {
            flags |= 0x100;
        }
        if (item.isCursed()) {
            flags |= 0x80;
        }
        if (item.isDamned()) {
            flags |= 0x40;
        }
        if (item.isUnpaid()) {
            flags |= 0x20;
        }
        if (item.isLocked()) {
            flags |= 0x10;
        }
        if (item.isApplied()) {
            flags |= 0x08;
        }
        if (item.isOpen()) {
            flags |= 0x04;
        }
        final int nrof = Math.max(1, item.getNrOf());
        final String name = nrof <= 1 ? item.getName() : nrof+" "+item.getName();
        commandSent(cmd+" "+item.getTag()+" "+nrof+" "+Math.max(0, item.getWeight())+" "+flags+" "+item.getType()+" "+name);
    }
 
    private void commandSentMap(@NotNull final CfMap map, final int x, final int y) {
        final StringBuilder sb = new StringBuilder("request map ");
        //noinspection SynchronizationOnLocalVariableOrMethodParameter
        synchronized (map) {
            final CfMapSquare square = map.getMapSquare(x, y);
            sb.append(x+posX-mapUpdaterState.getMapWidth()/2);
            sb.append(' ');
            sb.append(y+posY-mapUpdaterState.getMapHeight()/2);
            sb.append(' ');
            sb.append(square.getDarkness());
            sb.append(" n y n "); // XXX: smoothing
            sb.append(square.isFogOfWar() ? 'y' : 'n');
            sb.append(" smooth 0 0 0 heads"); // XXX: smoothing
            for (int i = 0; i < 3; i++) {
                sb.append(' ');
                final Face face = square.getFace(i);
                sb.append(face == CfMapSquare.DEFAULT_FACE ? 0 : face.getFaceNum());
            }
            sb.append(" tails");
            for (int i = 0; i < 3; i++) {
                final CfMapSquare headSquare = square.getHeadMapSquare(i);
                if (headSquare == null) {
                    sb.append(" 0");
                } else {
                    sb.append(' ');
                    final Face face = headSquare.getFace(i);
                    sb.append(face == CfMapSquare.DEFAULT_FACE ? 0 : face.getFaceNum());
                }
            }
        }
        commandSent(sb.toString());
    }
 
    @NotNull
    @Override
    public String toString() {
        return scriptId+" "+filename;
    }
 
    private void cmdRequest(@NotNull final String params) {
        if (params.equals("player")) {
            commandSent("request player "+itemSet.getPlayer().getTag()+" "+stats.getTitle());
        } else if (params.equals("range")) {
            commandSent("request range "+stats.getRange());
        } else if (params.equals("weight")) {
            commandSent("request weight "+stats.getStat(Stats.CS_STAT_WEIGHT_LIM)+" "+itemSet.getPlayer().getWeight());
        } else if (params.equals("stat stats")) {
            commandSent("request stat stats "+stats.getStat(Stats.CS_STAT_STR)+" "+stats.getStat(Stats.CS_STAT_CON)+" "+stats.getStat(Stats.CS_STAT_DEX)+" "+stats.getStat(Stats.CS_STAT_INT)+" "+stats.getStat(Stats.CS_STAT_WIS)+" "+stats.getStat(Stats.CS_STAT_POW)+" "+stats.getStat(Stats.CS_STAT_CHA));
        } else if (params.equals("stat stats_race")) {
            commandSent("request stat stats_race "+stats.getStat(Stats.CS_STAT_RACE_STR)+" "+stats.getStat(Stats.CS_STAT_RACE_CON)+" "+stats.getStat(Stats.CS_STAT_RACE_DEX)+" "+stats.getStat(Stats.CS_STAT_RACE_INT)+" "+stats.getStat(Stats.CS_STAT_RACE_WIS)+" "+stats.getStat(Stats.CS_STAT_RACE_POW)+" "+stats.getStat(Stats.CS_STAT_RACE_CHA));
        } else if (params.equals("stat stats_base")) {
            commandSent("request stat stats_base "+stats.getStat(Stats.CS_STAT_BASE_STR)+" "+stats.getStat(Stats.CS_STAT_BASE_CON)+" "+stats.getStat(Stats.CS_STAT_BASE_DEX)+" "+stats.getStat(Stats.CS_STAT_BASE_INT)+" "+stats.getStat(Stats.CS_STAT_BASE_WIS)+" "+stats.getStat(Stats.CS_STAT_BASE_POW)+" "+stats.getStat(Stats.CS_STAT_BASE_CHA));
        } else if (params.equals("stat stats_applied")) {
            commandSent("request stat stats_applied "+stats.getStat(Stats.CS_STAT_APPLIED_STR)+" "+stats.getStat(Stats.CS_STAT_APPLIED_CON)+" "+stats.getStat(Stats.CS_STAT_APPLIED_DEX)+" "+stats.getStat(Stats.CS_STAT_APPLIED_INT)+" "+stats.getStat(Stats.CS_STAT_APPLIED_WIS)+" "+stats.getStat(Stats.CS_STAT_APPLIED_POW)+" "+stats.getStat(Stats.CS_STAT_APPLIED_CHA));
        } else if (params.equals("stat cmbt")) {
            commandSent("request stat cmbt "+stats.getStat(Stats.CS_STAT_WC)+" "+stats.getStat(Stats.CS_STAT_AC)+" "+stats.getStat(Stats.CS_STAT_DAM)+" "+stats.getStat(Stats.CS_STAT_SPEED)+" "+stats.getStat(Stats.CS_STAT_WEAP_SP));
        } else if (params.equals("stat hp")) {
            commandSent("request stat hp "+stats.getStat(Stats.CS_STAT_HP)+" "+stats.getStat(Stats.CS_STAT_MAXHP)+" "+stats.getStat(Stats.CS_STAT_SP)+" "+stats.getStat(Stats.CS_STAT_MAXSP)+" "+stats.getStat(Stats.CS_STAT_GRACE)+" "+stats.getStat(Stats.CS_STAT_MAXGRACE)+" "+stats.getStat(Stats.CS_STAT_FOOD));
        } else if (params.equals("stat xp")) {
            final StringBuilder sb = new StringBuilder("request stat xp ");
            sb.append(stats.getStat(Stats.CS_STAT_LEVEL));
            sb.append(' ').append(stats.getExperience());
            for (int i = Stats.CS_STAT_SKILLINFO; i < Stats.CS_STAT_SKILLINFO+Stats.CS_NUM_SKILLS; i++) {
                final Skill skill = skillSet.getSkill(i);
                if (skill == null) {
                    sb.append(" 0 0");
                } else {
                    sb.append(' ').append(skill.getLevel());
                    sb.append(' ').append(skill.getExperience());
                }
            }
            commandSent(sb.toString());
        } else if (params.equals("stat resists")) {
            final StringBuilder sb = new StringBuilder("request stat resists");
            for (int i = Stats.CS_STAT_RESIST_START; i <= Stats.CS_STAT_RESIST_END; i++) {
                sb.append(' ');
                sb.append(stats.getStat(i));
            }
            // add dummy values for GTK client compatibility
            for (int i = Stats.CS_STAT_RESIST_END+1-Stats.CS_STAT_RESIST_START; i < 30; i++) {
                sb.append(" 0");
            }
            commandSent(sb.toString());
        } else if (params.equals("stat paths")) {
            commandSent("request stat paths "+stats.getStat(Stats.CS_STAT_SPELL_ATTUNE)+" "+stats.getStat(Stats.CS_STAT_SPELL_REPEL)+" "+stats.getStat(Stats.CS_STAT_SPELL_DENY));
        } else if (params.equals("flags")) {
            commandSent("request flags "+stats.getStat(Stats.CS_STAT_FLAGS)+" "+(commandQueue.checkFire() ? "1" : "0")+" "+(commandQueue.checkRun() ? "1" : "0")+" 0");
        } else if (params.equals("items inv")) {
            for (CfItem item : itemSet.getPlayerInventory()) {
                commandSentItem("request items inv", item);
            }
            commandSent("request items inv end");
        } else if (params.equals("items actv")) {
            for (CfItem item : itemSet.getPlayerInventory()) {
                if (item.isApplied()) {
                    commandSentItem("request items actv", item);
                }
            }
            commandSent("request items actv end");
        } else if (params.equals("items on")) {
            for (CfItem item : itemSet.getItemsByLocation(0)) {
                commandSentItem("request items on", item);
            }
            commandSent("request items on end");
        } else if (params.equals("items cont")) {
            final int containerTag = floorView.getCurrentFloorTag();
            if (containerTag != 0) {
                for (CfItem item : itemSet.getItemsByLocation(containerTag)) {
                    commandSentItem("request items cont", item);
                }
            }
            commandSent("request items cont end");
        } else if (params.equals("map pos")) {
            final CfMap map = mapUpdaterState.getMap();
            final int x;
            final int y;
            //noinspection SynchronizationOnLocalVariableOrMethodParameter
            synchronized (map) {
                x = posX;
                y = posY;
            }
            commandSent("request map pos "+x+" "+y);
        } else if (params.equals("map near")) {
            final CfMap map = mapUpdaterState.getMap();
            final int centerX = mapUpdaterState.getMapWidth()/2;
            final int centerY = mapUpdaterState.getMapHeight()/2;
            for (int y = -1; y <= +1; y++) {
                for (int x = -1; x <= +1; x++) {
                    commandSentMap(map, centerX+x, centerY+y);
                }
            }
        } else if (params.equals("map all")) {
            final CfMap map = mapUpdaterState.getMap();
            final int width = mapUpdaterState.getMapWidth()/2;
            final int height = mapUpdaterState.getMapHeight()/2;
            for (int y = 0; y < height; y++) {
                for (int x = 0; x < width; x++) {
                    commandSentMap(map, x, y);
                }
            }
        } else if (params.startsWith("map ")) {
            final String[] tmp = params.split(" +");
            if (tmp.length != 3) {
                reportError("syntax error: request "+params);
                return;
            }
 
            final int x;
            try {
                x = Integer.parseInt(tmp[1]);
            } catch (final NumberFormatException ignored) {
                reportError("syntax error: request "+params);
                return;
            }
 
            final int y;
            try {
                y = Integer.parseInt(tmp[2]);
            } catch (final NumberFormatException ignored) {
                reportError("syntax error: request "+params);
                return;
            }
 
            commandSentMap(mapUpdaterState.getMap(), x, y);
        } else if (params.equals("skills")) {
            for (int i = Stats.CS_STAT_SKILLINFO; i < Stats.CS_STAT_SKILLINFO+Stats.CS_NUM_SKILLS; i++) {
                final Object skill = skillSet.getSkill(i);
                if (skill != null) {
                    commandSent("request skills "+i+" "+skill);
                }
            }
            commandSent("request skills end");
        } else if (params.equals("spells")) {
            for (Spell spell : spellsManager.getAllSpells()) {
                commandSent("request spells "+spell.getTag()+" "+spell.getLevel()+" "+spell.getMana()+" "+spell.getGrace()+" "+spell.getSkill()+" "+spell.getPath()+" "+spell.getCastingTime()+" "+spell.getDamage()+" "+spell.getName());
            }
            commandSent("request spells end");
        } else {
            reportError("syntax error: request "+params);
        }
    }
 
    private void cmdIssueMark(@NotNull final String params) {
        final int tag;
        try {
            tag = Integer.parseInt(params);
        } catch (final NumberFormatException ignored) {
            reportError("syntax error: issue mark "+params);
            return;
        }
        crossfireServerConnection.sendMark(tag);
    }
 
    private void cmdIssueLock(@NotNull final String params) {
        final String[] tmp = params.split(" +", 2);
        if (tmp.length != 2) {
            reportError("syntax error: issue lock "+params);
            return;
        }
        final int val;
        final int tag;
        try {
            val = Integer.parseInt(tmp[0]);
            tag = Integer.parseInt(tmp[1]);
        } catch (final NumberFormatException ignored) {
            reportError("syntax error: issue lock "+params);
            return;
        }
        if (val < 0 || val > 1) {
            reportError("syntax error: issue lock "+params);
            return;
        }
        crossfireServerConnection.sendLock(val != 0, tag);
    }
 
    private void cmdIssueMove(@NotNull final String params, final int destTag, @NotNull final String commandName) {
        final String[] tmp = params.split(" +", 2);
        if (tmp.length != 1 && tmp.length != 2) {
            reportError("syntax error: issue "+commandName+" "+params);
            return;
        }
        final int tag;
        final int count;
        try {
            tag = Integer.parseInt(tmp[0]);
            count = tmp.length < 2 ? 0 : Integer.parseInt(tmp[1]);
        } catch (final NumberFormatException ignored) {
            reportError("syntax error: issue "+commandName+" "+params);
            return;
        }
        crossfireServerConnection.sendMove(destTag, tag, count);
    }
 
    private void cmdIssueApply(@NotNull final String params) {
        final int tag;
        try {
            tag = Integer.parseInt(params);
        } catch (final NumberFormatException ignored) {
            reportError("syntax error: issue apply "+params);
            return;
        }
        crossfireServerConnection.sendApply(tag);
    }
 
    private void cmdIssue(@NotNull final String params) {
        final Matcher matcher = PATTERN_ISSUE.matcher(params);
        if (!matcher.matches()) {
            commandQueue.sendRawString(params);
            return;
        }
 
        final int repeat;
        final int tmp;
        try {
            repeat = Integer.parseInt(matcher.group(1));
            tmp = Integer.parseInt(matcher.group(2));
        } catch (final NumberFormatException ignored) {
            reportError("syntax error: issue "+params);
            return;
        }
        if (tmp < 0 || tmp > 1) {
            reportError("syntax error: issue "+params);
            return;
        }
        final boolean mustSend = tmp != 0;
        final String command = matcher.group(3);
        commandQueue.sendNcom(mustSend, repeat, command);
    }
 
    private void cmdDraw(@NotNull final String params) {
        final String[] pps = params.split(" +", 2);
        if (pps.length != 2) {
            reportError("syntax error: draw "+params);
            return;
        }
        final int color;
        try {
            color = Integer.parseInt(pps[0]);
        } catch (final NumberFormatException ignored) {
            reportError("syntax error: draw "+params);
            return;
        }
        crossfireServerConnection.drawInfo(pps[1], color);
    }
 
    private void cmdMonitor() {
        if (!isMonitoring) {
            isMonitoring = true;
            crossfireServerConnection.addClientSocketListener(clientSocketListener);
        }
    }
 
    private void cmdUnmonitor() {
        if (isMonitoring) {
            isMonitoring = false;
            crossfireServerConnection.removeClientSocketListener(clientSocketListener);
        }
    }
 
    private void runScriptCommand(@NotNull final String cmdLine) {
        final String[] tmp = cmdLine.split(" +", 2);
        switch (tmp[0]) {
        case "watch":
            if (tmp.length == 1) {
                packetWatcher.addCommand("");
            } else if (tmp[1].indexOf(' ') != -1) {
                reportError("syntax error: "+cmdLine);
            } else {
                packetWatcher.addCommand(tmp[1]);
            }
            break;
 
        case "unwatch":
            packetWatcher.removeCommand(tmp.length >= 2 ? tmp[1] : "");
            break;
 
        case "request":
            if (tmp.length == 2) {
                cmdRequest(tmp[1]);
            } else {
                reportError("syntax error: "+cmdLine);
            }
            break;
 
        case "issue":
            if (tmp.length == 2) {
                final String tmp2 = tmp[1].split(" ", 2)[0];
                if (tmp2.equalsIgnoreCase("mark")) {
                    cmdIssueMark(tmp[1].substring(5));
                } else if (tmp2.equalsIgnoreCase("lock")) {
                    cmdIssueLock(tmp[1].substring(5));
                } else if (tmp2.equalsIgnoreCase("take")) {
                    cmdIssueMove(tmp[1].substring(5), itemSet.getPlayer().getTag(), "take");
                } else if (tmp2.equalsIgnoreCase("drop")) {
                    cmdIssueMove(tmp[1].substring(5), 0, "drop");
                } else if (tmp2.equalsIgnoreCase("apply")) {
                    cmdIssueApply(tmp[1].substring(6));
                } else {
                    cmdIssue(tmp[1]);
                }
            } else {
                reportError("syntax error: "+cmdLine);
            }
            break;
 
        case "draw":
            if (tmp.length == 2) {
                cmdDraw(tmp[1]);
            } else {
                reportError("syntax error: "+cmdLine);
            }
            break;
 
        case "monitor":
            if (tmp.length == 1) {
                cmdMonitor();
            } else {
                reportError("The 'monitor' command does not take arguments.");
            }
            break;
 
        case "unmonitor":
            if (tmp.length == 1) {
                cmdUnmonitor();
            } else {
                reportError("The 'unmonitor' command does not take arguments.");
            }
            break;
 
        default:
            reportError("unrecognized command from script: "+cmdLine);
            break;
        }
    }
 
    private void reportError(@NotNull final String string) {
        crossfireServerConnection.drawInfo(string, CrossfireDrawinfoListener.NDI_RED);
    }
 
    @Override
    public void addScriptProcessListener(@NotNull final ScriptProcessListener scriptProcessListener) {
        scriptProcessListeners.add(scriptProcessListener);
    }
 
    @Override
    public int compareTo(@NotNull final ScriptProcess o) {
        return Integer.compare(scriptId, o.getScriptId());
    }
 
    @Override
    public int hashCode() {
        return scriptId;
    }
 
    @Override
    public boolean equals(@Nullable final Object obj) {
        return obj instanceof final ScriptProcess scriptProcess && scriptProcess.getScriptId() == scriptId;
 
    }
 
}