SuspiciousMsgChecker.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.var.crossfire.model.validation.checks;
 
import java.util.Collections;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.model.validation.AbstractValidator;
import net.sf.gridarta.model.validation.ErrorCollector;
import net.sf.gridarta.model.validation.GameObjectValidator;
import net.sf.gridarta.model.validation.ValidatorPreferences;
import net.sf.gridarta.var.crossfire.model.validation.errors.SuspiciousMsgMagicEarWithoutMessageError;
import org.jetbrains.annotations.NotNull;
 
public class SuspiciousMsgChecker<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractValidator<G, A, R> implements GameObjectValidator<G, A, R> {
 
    @NotNull
    private static final Pattern PATTERN_REPLY = Pattern.compile("(@reply|@question)([ ]+)([^ ]+)([ ]+)(.+)");
 
    @NotNull
    private static final Pattern PATTERN_REPLY_WITHOUT_TEXT = Pattern.compile("(@reply|@question)[ ]+([^ ]+)");
 
    @NotNull
    private final RegExParser parser = new RegExParser();
 
    @NotNull
    private final ReplyValidator<G, A, R> replyValidator = new ReplyValidator<>();
 
    @NotNull
    private final TextValidator<G, A, R> textValidator = new TextValidator<>();
 
    @NotNull
    private final MagicEarValidator<G, A, R> magicEarValidator = new MagicEarValidator<>();
 
    @NotNull
    private final KeywordValidator<G, A, R> keywordValidator = new KeywordValidator<>();
 
    public SuspiciousMsgChecker(@NotNull final ValidatorPreferences validatorPreferences) {
        super(validatorPreferences);
    }
 
    @Override
    public void validateGameObject(@NotNull final G gameObject, @NotNull final ErrorCollector<G, A, R> errorCollector) {
        final String msg = gameObject.getMsgText(true);
        switch (gameObject.getTypeNo()) {
        case net.sf.gridarta.var.crossfire.model.archetype.Archetype.TYPE_MAGIC_EAR:
            if (msg == null || msg.isEmpty()) {
                errorCollector.collect(new SuspiciousMsgMagicEarWithoutMessageError<>(gameObject));
            } else {
                checkMessage(gameObject, errorCollector, msg, true);
            }
            break;
 
        default:
            if (msg != null) {
                for (final String line : msg.split("\n")) {
                    if (line.startsWith("@") || line.startsWith("match")) {
                        checkMessage(gameObject, errorCollector, msg, false);
                        break;
                    }
                }
            }
            break;
        }
    }
 
    private void checkMessage(@NotNull final G gameObject, @NotNull final ErrorCollector<G, A, R> errorCollector, @NotNull final String msg, final boolean magicEar) {
        if (!msg.isEmpty() && !msg.endsWith("\n")) {
            throw new IllegalArgumentException("message does not end with \\n: " + msg);
        }
        replyValidator.reset();
        textValidator.reset();
        magicEarValidator.reset();
        keywordValidator.reset();
 
        final ErrorGenerator<G, A, R> generator = new ErrorGenerator<>(errorCollector, gameObject);
 
        if (!msg.isEmpty()) {
            for (final String line : msg.substring(0, msg.length() - 1).split("\n", -1)) {
                generator.setCurrentLine(line);
                if (line.startsWith("@match ")) {
                    final String text = line.substring(7);
                    if (text.equals("*")) {
                        keywordValidator.match(generator, Collections.singleton("*"));
                    } else if (text.startsWith("*")) {
                        generator.errorMatchAllText();
                        keywordValidator.match(generator, Collections.singleton("*"));
                    } else {
                        parser.parse(text, generator);
                        keywordValidator.match(generator, parser.getWords());
                    }
 
                    if (magicEar) {
                        magicEarValidator.match(generator);
                    } else {
                        replyValidator.match();
                        textValidator.match(generator);
                    }
                } else if (line.equals("@match")) {
                    generator.errorSyntaxError("missing keywords after '@match'");
                    if (magicEar) {
                        magicEarValidator.match(generator);
                    } else {
                        replyValidator.match();
                        textValidator.match(generator);
                    }
                } else {
                    final Matcher matcher = PATTERN_REPLY.matcher(line);
                    if (matcher.matches()) {
                        final String keyword = matcher.group(1);
                        if (matcher.group(2).length() > 1) {
                            generator.errorKeywordError("the keyword '" + matcher.group(2).substring(1) + matcher.group(3) + "' after '" + keyword + "' starts with a space");
                        }
                        if (matcher.group(4).length() > 1) {
                            generator.errorKeywordError("the text '" + matcher.group(4).substring(1) + matcher.group(5) + "' after '" + keyword + "' starts with a space");
                        }
                        if (magicEar) {
                            magicEarValidator.reply(generator);
                        } else {
                            replyValidator.reply(generator);
                            textValidator.reply(generator);
                        }
                        keywordValidator.reply(generator, matcher.group(1), matcher.group(3));
                    } else {
                        final Matcher matcher2 = PATTERN_REPLY_WITHOUT_TEXT.matcher(line);
                        if (matcher2.matches()) {
                            final String keyword = matcher2.group(1);
                            generator.errorSyntaxError("missing text after '" + keyword + "'");
                            if (magicEar) {
                                magicEarValidator.reply(generator);
                            } else {
                                replyValidator.reply(generator);
                                textValidator.reply(generator);
                            }
                            keywordValidator.reply(generator, keyword, matcher2.group(2));
                        } else if (line.equals("@reply")) {
                            generator.errorSyntaxError("missing keyword after '@reply'");
                            if (magicEar) {
                                magicEarValidator.reply(generator);
                            } else {
                                replyValidator.reply(generator);
                                textValidator.reply(generator);
                            }
                        } else if (line.equals("@question")) {
                            generator.errorSyntaxError("missing keyword after '@question'");
                            if (magicEar) {
                                magicEarValidator.reply(generator);
                            } else {
                                replyValidator.reply(generator);
                                textValidator.reply(generator);
                            }
                        } else {
                            if (!magicEar) {
                                replyValidator.text(generator);
                            }
                            if (line.isEmpty()) {
                                if (magicEar) {
                                    magicEarValidator.empty(generator);
                                } else {
                                    textValidator.empty(generator);
                                }
                            } else {
                                if (line.startsWith("match")) {
                                    generator.errorSyntaxError("a text line starts with 'match'. Maybe '@match' was intended?");
                                } else if (line.startsWith("@")) {
                                    generator.errorSyntaxError("unrecognized keyword: '" + line + "'");
                                }
                                if (magicEar) {
                                    magicEarValidator.text(generator);
                                } else {
                                    textValidator.text(generator);
                                }
                            }
                        }
                    }
                }
            }
        }
 
        if (magicEar) {
            magicEarValidator.eof(generator);
        } else {
            textValidator.eof(generator);
        }
        keywordValidator.eof(generator);
    }
 
}