Filenames.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.settings;
 
import com.realtime.crossfire.jxclient.util.HexCodec;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class Filenames {
 
    private Filenames() {
    }
 
    @NotNull
    public static Path getOriginalImageCacheDir() {
        try {
            return getSettingsFile("cache");
        } catch (final IOException ex) {
            System.err.println(ex.getMessage());
            System.exit(1);
            throw new AssertionError(ex);
        }
    }
 
    @NotNull
    public static Path getScaledImageCacheDir() {
        try {
            return getSettingsFile("cache-x2");
        } catch (final IOException ex) {
            System.err.println(ex.getMessage());
            System.exit(1);
            throw new AssertionError(ex);
        }
    }
 
    @NotNull
    public static Path getMagicMapImageCacheDir() {
        try {
            return getSettingsFile("cache-mm");
        } catch (final IOException ex) {
            System.err.println(ex.getMessage());
            System.exit(1);
            throw new AssertionError(ex);
        }
    }
 
    @NotNull
    public static Path getSettingsFile() throws IOException {
        return getSettingsFile("jxclient.conf");
    }
 
    @NotNull
    public static Path getShortcutsFile(@NotNull final CharSequence hostname, @NotNull final CharSequence character) throws IOException {
        return getSettingsFile("shortcuts-"+encode(hostname)+"-"+encode(character)+".txt");
    }
 
    @NotNull
    public static Path getKeybindingsFileVersion2(@Nullable final CharSequence hostname, @Nullable final CharSequence character) throws IOException {
        return getSettingsFile(hostname == null || character == null ? "keybindings2.txt" : "keybindings2-"+encode(hostname)+"-"+encode(character)+".txt");
    }
 
    @NotNull
    public static Path getKeybindingsFileVersion1(@Nullable final CharSequence hostname, @Nullable final CharSequence character) throws IOException {
        return getSettingsFile(hostname == null || character == null ? "keybindings.txt" : "keybindings-"+encode(hostname)+"-"+encode(character)+".txt");
    }
 
    @Nullable
    public static Path getMetaserverCacheFile() {
        try {
            return getSettingsFile("metaserver.txt");
        } catch (final IOException ex) {
            System.err.println("Cannot access metaserver cache file: "+ex.getMessage());
            return null;
        }
    }
 
    @NotNull
    public static Path getDialogsFile(@NotNull final String skinName) throws IOException {
        return getSettingsFile("skin_"+skinName).resolve("dialogs.txt");
    }
 
    @NotNull
    public static Path getSettingsFile(@NotNull final String filename) throws IOException {
        final Path settingsDir = getCrossfireFile().resolve("jxclient");
        Files.createDirectories(settingsDir);
        return settingsDir.resolve(filename);
    }
 
    @NotNull
    private static Path getCrossfireFile() throws IOException {
        final String home = System.getProperty("user.home");
        if (home == null) {
            throw new IOException("cannot find home directory");
        }
 
        return Paths.get(home).resolve(".crossfire");
    }
 
    @NotNull
    private static String encode(@NotNull final CharSequence str) {
        final StringBuilder sb = new StringBuilder();
        for (int i = 0; i < str.length(); i++) {
            final char ch = str.charAt(i);
            if (('a' <= ch && ch <= 'z') || ('A' <= ch && ch <= 'Z') || ('0' <= ch && ch <= '9') || ch == '-' || ch == '_' || ch == '.') {
                sb.append(ch);
            } else {
                sb.append('%');
                HexCodec.hexEncode2(sb, ch);
            }
        }
        return sb.toString();
    }
 
    @NotNull
    public static Path getMessageLogFile(@Nullable final String hostname) throws IOException {
        return getSettingsFile(hostname == null ? "jxclient.txt" : "jxclient-"+hostname+".txt");
    }
 
}