MetaserverEntryParser.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.metaserver;
 
import com.realtime.crossfire.jxclient.util.NumberParser;
import java.io.IOException;
import java.util.regex.Pattern;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class MetaserverEntryParser {
 
    @NotNull
    private static final String UNKNOWN_VERSION = "?";
 
    @NotNull
    private static final String DEFAULT_BASE = "not specified";
 
    @NotNull
    private static final Pattern FIELD_SEPARATOR_PATTERN = Pattern.compile("\\|");
 
    private boolean inSection;
 
    private int updateSeconds;
 
    @Nullable
    private String hostname;
 
    private int port;
 
    private int players;
 
    @NotNull
    private String version = UNKNOWN_VERSION;
 
    @NotNull
    private String comment = "";
 
    private long bytesIn;
 
    private long bytesOut;
 
    private int uptimeSeconds;
 
    @NotNull
    private String archBase = DEFAULT_BASE;
 
    @NotNull
    private String mapBase = DEFAULT_BASE;
 
    @NotNull
    private String codeBase = DEFAULT_BASE;
 
    public MetaserverEntryParser() {
        clear();
    }
 
    @Nullable
    public static MetaserverEntry parseEntry(@NotNull final CharSequence entry) {
        final String[] entries = FIELD_SEPARATOR_PATTERN.split(entry, -1);
        if (entries.length != 11) {
            return null;
        }
 
        final int updateSeconds;
        final String hostname;
        final int players;
        final String version;
        final String comment;
        final long bytesIn;
        final long bytesOut;
        final int uptimeSeconds;
        final String archBase;
        final String mapBase;
        final String codeBase;
        try {
            updateSeconds = Integer.parseInt(entries[0]);
            hostname = entries[1];
            players = Integer.parseInt(entries[2]);
            version = entries[3];
            comment = entries[4];
            bytesIn = Long.parseLong(entries[5]);
            bytesOut = Long.parseLong(entries[6]);
            uptimeSeconds = Integer.parseInt(entries[7]);
            archBase = entries[8];
            codeBase = entries[9];
            mapBase = entries[10];
        } catch (final NumberFormatException ignored) {
            return null;
        }
 
        return new MetaserverEntry(updateSeconds, hostname, players, version, comment, bytesIn, bytesOut, uptimeSeconds, archBase, codeBase, mapBase);
    }
 
    @Nullable
    public MetaserverEntry parseLine(@NotNull final String line) throws IOException {
        if (inSection) {
            if (line.equals("END_SERVER_DATA")) {
                @Nullable final MetaserverEntry metaserverEntry;
                if (hostname == null) {
                    System.err.println("Warning: metaserver response missing hostname field, skipping");
                    metaserverEntry = null;
                } else {
                    metaserverEntry = new MetaserverEntry(updateSeconds, port == 13327 ? hostname : hostname+":"+port, players, version, comment, bytesIn, bytesOut, uptimeSeconds, archBase, mapBase, codeBase);
                }
                clear();
                inSection = false;
                return metaserverEntry;
            }
            final String[] tmp = line.split("=", 2);
            if (tmp.length == 2) {
                final String key = tmp[0];
                final String value = tmp[1];
                switch (key) {
                case "hostname":
                    hostname = value;
                    break;
 
                case "port":
                    port = NumberParser.parseInt(value, 13327);
                    break;
 
                case "html_comment":
                    comment = value;
                    break;
 
                case "text_comment":
                    if (comment.isEmpty()) {
                        comment = value;
                    }
                    break;
 
                case "archbase":
                    archBase = value;
                    break;
 
                case "mapbase":
                    mapBase = value;
                    break;
 
                case "codebase":
                    codeBase = value;
                    break;
 
                case "num_players":
                    players = NumberParser.parseInt(value, 0);
                    break;
 
                case "in_bytes":
                    bytesIn = NumberParser.parseLong(value, 0);
                    break;
 
                case "out_bytes":
                    bytesOut = NumberParser.parseLong(value, 0);
                    break;
 
                case "uptime":
                    uptimeSeconds = NumberParser.parseInt(value, 0);
                    break;
 
                case "version":
                    version = value;
                    break;
 
                case "sc_version":
                    break;
 
                case "cs_version":
                    break;
 
                case "last_update":
                    final long now = (System.currentTimeMillis()+500)/1000;
                    final long uptime = NumberParser.parseLong(value, now);
                    updateSeconds = Math.max((int)((uptime-now)/1000), 0);
                    break;
 
                case "flags":
                    break;
 
                default:
                    System.err.println("Ignoring unknown key: "+key);
                    break;
                }
            } else {
                throw new IOException("syntax error: "+line);
            }
        } else {
            if (line.equals("START_SERVER_DATA")) {
                inSection = true;
            } else {
                throw new IOException("syntax error: "+line);
            }
        }
 
        return null;
    }
 
    private void clear() {
        updateSeconds = 0;
        hostname = null;
        port = 13327;
        players = 0;
        version = UNKNOWN_VERSION;
        comment = "";
        bytesIn = 0;
        bytesOut = 0;
        uptimeSeconds = 0;
        archBase = DEFAULT_BASE;
        mapBase = DEFAULT_BASE;
        codeBase = DEFAULT_BASE;
    }
 
    @NotNull
    public static String format(@NotNull final MetaserverEntry entry) {
        return entry.getUpdateSeconds()+"|"+replace(entry.getHostname())+"|"+entry.getPlayers()+"|"+replace(entry.getVersion())+"|"+replace(entry.getComment())+"|"+entry.getBytesIn()+"|"+entry.getBytesOut()+"|"+entry.getUptimeSeconds()+"|"+replace(entry.getArchBase())+"|"+replace(entry.getCodeBase())+"|"+replace(entry.getMapBase());
    }
 
    @NotNull
    private static String replace(@NotNull final String str) {
        return str.replaceAll("[|\r\n]", " ");
    }
 
}