DefaultFaceObjects.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2023 The Gridarta Developers.
 *
 * This program 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.
 *
 * This program 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 this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
package net.sf.gridarta.model.face;
 
import java.io.BufferedReader;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.net.URL;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import net.sf.gridarta.model.errorview.ErrorView;
import net.sf.gridarta.model.errorview.ErrorViewCategory;
import net.sf.gridarta.model.errorview.ErrorViewCollector;
import net.sf.gridarta.utils.ActionBuilderUtils;
import net.sf.gridarta.utils.ArrayUtils;
import net.sf.gridarta.utils.IOUtils;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import org.apache.log4j.Category;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
 
public class DefaultFaceObjects extends AbstractFaceObjects {
 
    private static final long serialVersionUID = 1L;
 
    private static final int CHUNK_SIZE = 4096;
 
    @NotNull
    private static final Category LOG = Logger.getLogger(DefaultFaceObjects.class);
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    private final boolean includeFaceNumbers;
 
    public DefaultFaceObjects(final boolean includeFaceNumbers) {
        super(ActionBuilderUtils.getString(ACTION_BUILDER, "nameOfFaceObject"));
        this.includeFaceNumbers = includeFaceNumbers;
    }
 
    @NotNull
    @Override
    public FaceProvider loadFacesCollection(@NotNull final ErrorView errorView, @NotNull final File collectedDirectory) {
        final String faceFile = ActionBuilderUtils.getString(ACTION_BUILDER, "configSource.image.name");
        final String treeFile = ActionBuilderUtils.getString(ACTION_BUILDER, "configSource.facetree.name");
        final File tmpFaceFile;
        try {
            tmpFaceFile = IOUtils.getFile(collectedDirectory, faceFile);
        } catch (final IOException ex) {
            errorView.addWarning(ErrorViewCategory.FACES_FILE_INVALID, new File(collectedDirectory, faceFile) + ": " + ex.getMessage());
            return new EmptyFaceProvider();
        }
        final CollectedFaceProvider collectedFaceProvider;
        int faces = 0;
        final ErrorViewCollector faceFileErrorViewCollector = new ErrorViewCollector(errorView, tmpFaceFile);
        try {
            collectedFaceProvider = new CollectedFaceProvider(tmpFaceFile);
            final byte[] data = getFileContents(tmpFaceFile);
 
            // Note: treeIn might stay null, this is optional data.
            final ErrorViewCollector treeFileErrorViewCollector = new ErrorViewCollector(errorView, new File(collectedDirectory, treeFile));
            BufferedReader treeIn = null;
            try {
                final URL url = IOUtils.getResource(collectedDirectory, treeFile);
                final InputStream inputStream2 = url.openStream();
                final Reader reader = new InputStreamReader(inputStream2, IOUtils.MAP_ENCODING);
                //cher: it is safely closed but optional. InspectionGadgets doesn't detect where it's closed.
                treeIn = new BufferedReader(reader);
            } catch (final FileNotFoundException ignored) {
                treeFileErrorViewCollector.addWarning(ErrorViewCategory.FACES_FILE_INVALID);
            }
            final byte[] tag = "IMAGE ".getBytes(); // this is the starting string for a new png
            try {
                final Pattern pattern = Pattern.compile(ActionBuilderUtils.getString(ACTION_BUILDER, "configSource.facetree.input"));
                int offset = 0;
                // face name of png
                final StringBuilder faceB = new StringBuilder();
                while (offset < data.length) {
                    // File: Structure*
                    // Structure: "IMAGE " seqNr ' ' size ' ' facename '\n' PNGBinary (if includeFaceNumbers)
                    // Structure: "IMAGE "           size ' ' facename '\n' PNGBinary (if !includeFaceNumbers)
                    if (!ArrayUtils.contains(data, offset, tag)) { // check for IMAGE
                        throw new IOException("expecting 'IMAGE' at position " + offset);
                    }
                    offset += 6; // skip "IMAGE ";
                    if (includeFaceNumbers) {
                        while (data[offset++] != 0x20) {
                            // skip seqNr ' '
                        }
                    }
                    int size = 0;
                    // read size ' '
                    while (true) {
                        final char c = (char) data[offset++]; // XXX: do not cast from byte to char
                        if (c == ' ') {
                            break;
                        }
                        if (c < '0' || c > '9') {
                            throw new IOException("syntax error at position " + offset + ": not a digit");
                        }
                        size *= 10;
                        size += c - '0';
                    }
                    faceB.setLength(0);
                    // read facename '\n'
                    while (true) {
                        final char c = (char) data[offset++]; // XXX: do not cast from byte to char
                        if (c == '\n') {
                            break;
                        }
                        if (c == '/') {
                            faceB.setLength(0);
                        } else {
                            faceB.append(c);
                        }
                    }
                    final String faceName = faceB.toString().intern();
 
                    if (offset + size > data.length) {
                        throw new IOException("truncated at position " + offset);
                    }
 
                    if (treeIn != null) {
                        final String originalFilename = treeIn.readLine();
                        if (originalFilename == null) {
                            LOG.warn(ACTION_BUILDER.format("logFaceObjectWithoutOriginalName", faceName));
                        } else {
                            final Matcher matcher = pattern.matcher(originalFilename);
                            if (matcher.matches()) {
                                try {
                                    addFaceObject(faceName, matcher.group(1), offset, size);
                                } catch (final DuplicateFaceException ex) {
                                    faceFileErrorViewCollector.addWarning(ErrorViewCategory.FACES_ENTRY_INVALID, "duplicate face: " + ex.getDuplicate().getFaceName());
                                } catch (final IllegalFaceException ex) {
                                    faceFileErrorViewCollector.addWarning(ErrorViewCategory.FACES_ENTRY_INVALID, "invalid face: " + ex.getFaceObject().getFaceName());
                                }
                            } else {
                                treeFileErrorViewCollector.addWarning(ErrorViewCategory.FACES_ENTRY_INVALID, "syntax error: " + originalFilename);
                            }
                        }
                    }
                    collectedFaceProvider.addInfo(faceName, offset, size); // TODO Remove me
                    faces++;
                    offset += size;
                }
            } finally {
                if (treeIn != null) {
                    treeIn.close();
                }
            }
        } catch (final IOException ex) {
            faceFileErrorViewCollector.addWarning(ErrorViewCategory.FACES_FILE_INVALID, ex.getMessage());
            return new EmptyFaceProvider();
        }
        if (LOG.isInfoEnabled()) {
            LOG.info("Loaded " + faces + " faces from '" + tmpFaceFile + "'.");
        }
        return collectedFaceProvider;
    }
 
    private static byte @NotNull [] getFileContents(@NotNull final File file) throws IOException {
        final ByteArrayOutputStream bufOut = new ByteArrayOutputStream((int) file.length());
        try (InputStream inputStream = new FileInputStream(file)) {
            final byte[] buf = new byte[CHUNK_SIZE];
            while (true) {
                final int len = inputStream.read(buf);
                if (len == -1) {
                    break;
                }
                bufOut.write(buf, 0, len);
            }
        }
        return bufOut.toByteArray();
    }
 
    @Override
    public boolean isIncludeFaceNumbers() {
        return includeFaceNumbers;
    }
 
}